CONTRIBUTING.md

Development Environment

We recommend a virtual python environment for development. The setup process is described in detail in our GettingStarted.

Testing

SaQC comes with an extensive test suite based on pytest. In order to run all tests execute:

python -m pytest .

Coding conventions

Naming

Code

We follow the follwing naming conventions:

• Classes: CamelCase
• Functions: camelCase
• Variables/Arguments: snake_case

Test Functions

• testnames: [testmodule_]flagTestName

Formatting

We use (black)[https://black.readthedocs.io/en/stable/] with a line length if 120 characters. Within the SaQC root directory run black -l 120.

Imports

Only absolute imports are accepted.