CONTRIBUTING.md

Development Environment

We recommend an virtual python environment for development. The setup process consists of the follwing simply steps:

1. Create a fresh environment with:

   python -m venv saqc_dev

2. Activate the created environment

   source saqc_dev/bin/activate

3. Install the dependencies

   python -m pip install -r requirements.txt

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