Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 567 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 567 Bytes

Developer guide

Requirements

unit and integration tests are mandatory.

Please use Conventional Commits.

Please ensure you have run the following before pushing a commit:

  • black and isort (or invoke reformat)
  • tox to run all linters

Coding style

Follow usual best practices:

  • document your code (inline and docstrings)
  • constants are in upper case
  • use comprehensible variable name
  • one function = one purpose
  • function name should perfectly define their purpose