Meet the Research Software quality standards
Meet the Research Software quality standards
Minimum requirements for your software management during your research are:
1. Version control: Research Software is versioned, and ideally tracked in an explicit system for version control and repository, e.g. git and GitLab, respectively.
2. Documentation: During the creation of the research software, some documentation is written where you explain what the software does and how it should be used.
3. Licensing: Apply a license if you are developing publicly
More good software practices are recommended (especially when creating a standalone tool, library, or module in an existing tool) This could include writing software tests and using code quality tools.
If you are expecting your software will be used by others, consider:
• Releasing your software
• Easy installation (e.g. package managers)
• Issue tracker
If you are expecting contributors to the software, consider the following additional recommendations:
• Write development documentation
• Create contribution guidelines
• Add a means of communication
Using good and appropriate software management practices will save time in the long run.