Skip to content

Instantly share code, notes, and snippets.

@mgxd

mgxd/list.md

Last active May 18, 2021 17:53
Show Gist options
  • Save mgxd/b0acb43dabc983b34700ab8be7c9220d to your computer and use it in GitHub Desktop.
Save mgxd/b0acb43dabc983b34700ab8be7c9220d to your computer and use it in GitHub Desktop.
Download ZIP
NMinD coding standards checklist
Raw
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%?)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment