This tool exists and is reasonably useable by (at least) advanced users, with minimal useability for basic users.
TODO: Insert example Bronze cookie-cutter here.
- README provides link to documentation
- Documentation is up-to-date
- Brief description of what program does is listed
- Typical intended usage is described
- An example of its usage is shown
- User installation instructions available
- Dependencies listed (external and within-langugage requirements)
- Description of required input parameters with reasonable description of inputs (i.e. "Nifti of brain mask in MNI" vs. "An image file")
- Description of output(s)
- Document functions intended to be used by users (public function docstring / help coverage ≥ 10%)
- Package is under version control.
- Readme is present.
- License is present.
- Issues tracking is enabled (either through GitHub or external site).
- Contributing guidelines (Intent of not maintenance?)
- Adding NMinD template for users with important questions
- Digital Object Identifier points to project (e.g., Zenodo)
- For new changes to be merged, all tests need to pass
No bronze-level requirements
Some of these can be enforced by GitHub.
- If a package / compiled-code ― successfully builds / installs. If containerized, container availble or build recipe succeeds
- Provide / generate / point to test data
- Provide instructions for users to run tests
- Pointers on how to add these things (TODO)
- Guiding principles (TODO)
- Document tools used for determining coverage (TODO)
- Being able to cite the software in grant applications and publications! (DOI)
- Reasonable degree of certainty other will be able to install and use your code!