proposals
proposals copied to clipboard
Intermediate Python Software Development Skills Course
-
What is the topic of your lesson or lesson proposal? Intermediate Research Software Development in Python
-
Do you already have a draft of your lesson? You're welcome to share materials at any stage of development. If you already have drafted materials, please include a link. Yes, the (currently private) lesson repository is at: https://github.com/softwaresaved/swc-intermediate-lesson and the rendered website: https://softwaresaved.github.io/swc-intermediate-lesson/.
-
Do your materials conform to our Code of Conduct? Yes.
-
Are your materials already on GitHub and do they use The Carpentries lesson template? (you can visit our lesson example to learn more about how to use our template). Yes. We are looking to transfer the repository to the Incubator either by transferring the organisational ownership on the existing repo or starting from a blank repo in the Incubator with the latest lesson template and copying over our content. We are open to suggestions as to the best thing to do.
-
If you answered "No" to either part of question 4, would you like our Curriculum Team to create a repository for you in The Carpentries Incubator? Either option 5. or 6. are acceptable - will go with what The Carpentries suggest.
-
If you answered "Yes" to both parts of question 4, would you like to transfer your repository to The Carpentries Incubator? You will have Admin access to the repository. Either option 5. or 6. are acceptable - will go with what The Carpentries suggest.
-
If you answered "Yes" to either question 5 or 6, list the GitHub handles for people who should have Maintain access to your lesson. If you don't know how to answer this question, don't worry! We can always add collaborators later. Steve Crouch: https://github.com/steve-crouch James Graham]: https://github.com/jag1g13 Aleksandra Nenadic: https://github.com/anenadic
-
Any other information you would like us to have or questions you have for us? As the suggested name for the course is “Intermediate Research Software Development in Python” the new repository name could perhaps be 'intermediate-rsd-python' to match and leave space for a similar course in R. Open to suggestions.
Hey @anenadic I'm excited to see this material enter the Incubator. I'm sure it will be very relevant to many in the community. I will make a Team for you all as maintainers of the lesson, and you can then transfer the repository over here.
As far as the repository name goes, I think intermediate-python-rsd is good, though I am not so sure how obvious rsd will be as an abbreviation to many in the community? To fit with the existing naming convention for Software Carpentry programming lessons, you might also consider mentioning the domain of the data set used in any examples throughout the lesson (see python-novice-gapminder and python-novice-inflammation as examples of what I mean). Regardless, I recommend to rename the repository as soon as it is transferred, so that everyone only needs to update their remote URLs, bookmarks, etc once.
Thank you @tobyhodges! We had the exact thoughts around the abbreviation 'rsd' not being immediately obvious and also used to call the project 'python-intermediate-inflammation' initially as it continues to use SWC's inflammation data used in one of the SWC's Python lesson but then if focuses on collaborative software engineering skills and wanted to emphasise that. I will talk to the other members of the development team again about renaming.
I have created the Team and added you as a maintainer, @anenadic. I also invited James and Steve. Please post back here with a link to the repository after the transfer and renaming has been done, then I will close this thread. And, of course, post here as well if you need any help with the process!
We have now transferred the repo to The Carpentries Incubator 🎉 : https://github.com/carpentries-incubator/python-intermediate-development/ @tobyhodges. Questions:
- How do we licence the lesson material?
- How should we manage access of external collaborators who had access to the original repository and whose access has been transferred to the repo in the Incubator?
Hi @anenadic,
I'm following up on issues while Toby is on family leave.
If submitted carpentries-incubator/python-intermediate-development#1 which will switch the copyright notice to "the authors" (it's still CC-BY but shows that it's not an official Carpentries lesson).
For the external collaborators access, I'll make you an admin on the repo so you can invite others as needed. Thanks!
I just checked and you already have admin access for this repo so you should be able to invite others who don't have access yet.
Hi @fmichonneau, yes we (the team developing the material) already have the admin access - Toby created the team for us before he left on his paternity leave.
Thanks for the PR and input on licensing and copyright - we were not sure if we needed to transfer the copyright to The Carpentries (and were of course happy with CC-BY licence). We may change that copyright line in the future to our individual institutions - hope that is OK. We are also getting advice on this from Neil Chue Hong, the Software Sustainability Institute Director. If you have any other advice on the copyright - please let us know. Otherwise, I think we can close this issue 🎉 !