README.md

Good Practices in Research Software Development

During 'Good Practices in Research Software Development' workshops, researchers learn good software practices and skills to facilitate open and reproducible research. The workshops focus on methods to build modular, reusable, maintainable, sustainable, reproducible, testable, and robust software.

NB: This lesson overlaps largely with CodeRefinery lessons.

Syllabus

1. Introduction to good practices in research software development (0:15 hours)
2. Introduction to git (3:12 hours)
3. Collaboration with git and Github (3:00 hours)
4. Modular code development (2:00 hours)
5. Documentation (1:00 hours)
6. Testing and continuous integration (2:30 hours)

Recommended schedule for a 4 half-day course (or 2 full days)

Half-day 1

1. Optional introduction to git (only participants without any experience to git join)

Half-day 2

1. Introduction to good practices in research software development
2. Collaboration with git and Github

Half-day 3

1. Modular code development
2. Documentation

Half-day 4

1. Testing and continuous integration
2. Wrap up

Exercises document

You can use the exercises document