[Proposal]: Good practices in research software development

[svenvanderburg]

1. Lesson Topic

Good practices in research software development

2. Lesson Language

English

3. Draft materials

https://github.com/esciencecenter-digital-skills/good-practices-lesson

4. Requirements for existing materials

• [X] do your lesson materials conform to our Code of Conduct?
• [X] are your materials already on GitHub and do they use The Carpentries lesson template or The Carpentries Workbench? (you can visit the Workbench tutorial to learn more about how to use our lesson infrastructure).

5. New repository creation

• [ ] I need a new repository created

6. Transfer existing repository

• [X] my lesson meets both criteria in part 4 and I would like to transfer the repository to The Carpentries Incubator

7. Collaborators

@lyashevska @svenvanderburg

8. Info/Questions

Heavily inspired by CodeRefinery, but started to deviate too much.

Syllabus: Code Documentation

• In-code documentation
• Readme files
• Writing documentation with sphinx and ReadTheDocs or Github pages

Modular Code Development

• How can you create blocks of code that can be reused?

Testing

• Introduction to testing: motivation, unit testing, integration testing
• Writing tests with pytest

Continuous Integration

• Introduction to Continuous Integration
• Setting up Continuous Integration with Github Workflows
• Linting and automated testing

[tobyhodges]

This looks very cool, thanks for sharing @svenvanderburg.

Before I set things up to allow the lesson to be transferred, please could you add some more attribution to Code Refinery, e.g. mentioning and linking to the relevant lesson(s), on the repository README and in index.md?

[svenvanderburg]

Yes indeed that is something we should have done earlier, and the Readme should get an update anyway. I opened 2 issues:

• https://github.com/esciencecenter-digital-skills/good-practices-lesson/issues/38
• https://github.com/esciencecenter-digital-skills/good-practices-lesson/issues/39

Also see https://github.com/coderefinery/reproducible-research/issues/266

Regarding timeline: we will probably pick this up around December/January.