Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 933 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (20 loc) · 933 Bytes

Please follow the Python PEP8 standard (https://www.python.org/dev/peps/pep-0008/)

An extension (class, method, etc.) is finished, when

  1. The code is working (e.g. known bugs are resolved)
  2. The code is tested (e.g. unit tests, integration test)
  3. The code is documented (e.g. docstrings)
  4. The documentation can be generated automatically using sphinx

###Commit Messages

Please start your commit messages with an appropriate acronym:

  • API: an (incompatible) API change
  • BLD: change related to building the module
  • BUG: bug fix
  • DATA: change related to the data
  • DEP: deprecate something, or remove a deprecated object
  • DEV: development, enhancement or utility
  • DOC: documentation
  • MAINT: maintenance commit (refactoring, typos, etc.)
  • REV: revert an earlier commit
  • STY: style fix (whitespace, PEP8)
  • TST: addition or modification of tests
  • WIP: development work in progress