aki_prj23_transparenzregister/CONTRIBUTING.md

Contribution guidelines

Code style

We defined to use the following formats:

• Whitespace Formatting by Black
• Docstrings Style see the examples provided by sphinx napoleon Types in the docstrings are optional but should be consistent per module.
• Import Order by isort
• Strict Typing of function headers see the examples provided by the mypy documentation.

Language

We decided to use english on everything close to code but will write longer texts that are not close to the code in german.

Pre-Commit installation

• clone the project

• install the following python package:

  • pre-commit

• execute the command pre-commit install to insert the git githook into your local repository.

  • for more information read Python Pre-Commit
  • the following code format rules are so enforced:
    • Whitespace formatierung:
      • Python-Black
      • leading whitespace in all files
      • Auto format: yaml, toml, ini
    • Import norm by:
      • isort
      • absolut module path
    • Validierung:
      • yaml, toml, json, xml
      • Secret detection
      • python normen (pep8) with flake8
      • type checking with (mypy)