Coding guidelines

General guidelines

All software is built in modules, unit tests have to be added for each module/functionality.

The CI pipeline also automates some code style enforcement via a pre-commit. We recommend to configure it locally such that it runs automatically on every commit:

pip install pre-commit
pre-commit install

For more information about pre-commit check here and this short video series: https://calmcode.io/pre-commit/the-problem.html

Please be aware that the isort pre-commit hook accidentally sorts our own code with third party libraries, also see: https://github.com/PyCQA/isort/issues/2068 Be therefore sure to not commit python code from a worktree.

Language-specific

• C++ Coding Guidelines
• Python Coding Guidelines