NMinD coding standards checklist

list.md

Documentation

• Brief description of what program does is listed.
• An example of its usage is shown.
• Description of required input parameters.
• Description of output parameters.
• Extensive documentation of available parameters

Infrastructure

• Readme is present.
• License is present.
• Issues are enabled.
• Issue template(s) available (information requested by developers).
• Contribution Guide present.
• Code of Conduct present.

Code

• Installation instructions available.
• No excessive files included (gitignore).
• Follows a style guide (i.e., Python and Flake8)

Testing

• Package successfully builds/installs.
• Some form of testing framework present.
• Unit testing
• Integration testing
• Smoke tests
• Lines-hit tracker (>50%?)