NMIND certif

[Remi-Gau]

NMIND bronze certif

testing

• Provide / generate / point to test data
• Provide instructions for users to run tests that include instructions for evaluation for correct behavior

infrastructure

• Code is open source
• Package is under version control
• Readme is present
• License is present
• Issues tracking is enabled
• Digital Object Identifier (DOI) points to latest version
• All documented installation instructions can be successfully followed

documentation

• Landing page (e.g., GitHub README, website) provides a link to documentation and brief description of what program does
• Documentation is up to date with version of software
• Typical intended usage is described
• An example of its usage is shown
• Document functions intended to be used by users
• Description of required input parameters for user-facing functions with reasonable description of inputs
• Description of output(s)
• User installation instructions available
• Dependencies listed

NMIND silver certif

testing

• Some form of testing suite present
• Test coverage > 50%

infrastructure

• Issue template(s) available
• Continuous integration runs tests
• No excessive files included

documentation

• Background/significance of program
• One or more tutorial to showcase the multiple of the program's usages
• Any alternative usage that is advertised is thoroughly documented
• Thorough description of required and optional input parameters
• Document public functions
• A statement of supported operating systems / environments

NMIND gold certif

testing

• Test coverage > 90%
• Benchmarking information is provided for examples

infrastructure

• Continuous integration builds packages
• Continuous integration validates style
• Journal of Open Source Software submission
• Contribution guide present
• Code of Conduct present

documentation

• Continuous integration badges in README for build status
• Continuous integration badges in README for tests passing
• Continuous integration badges in README for coverage
• Document functions, classes, modules, etc.
• Has a documented style guide
• Maintenance status is documented