Software checklist
Here we provide a short checklist for software projects, the rest of this chapter elaborates on the various point in this list.
The bare minimum that every software project should do, from the start, is:
- Pick & include an open source license
- Use version control
- Use a publicly accessible
version control repository - Add a readme describing the project
We recommend that you also do the following (from the start of the project):
Additional steps depend on the goal of the software (zero or more can apply):
I’m publishing a paper
- Add a CITATION.cff file
- Make your software citable
- Cite DOI in paper
I’m expecting users
- Release your software
- Provide user documentation
- Easy installation
- Provide issue tracker
I’m expecting contributors
- Provide development documentation
- Provide a means of communication
- Implement and add a code of conduct
- Contribution guideline