Skip to content
Snippets Groups Projects
CONTRIBUTING.md 503 B
Newer Older
David Schäfer's avatar
David Schäfer committed
# Coding conventions
David Schäfer's avatar
David Schäfer committed
## Naming
David Schäfer's avatar
David Schäfer committed
### Code
We follow the follwing naming conventions
David Schäfer's avatar
David Schäfer committed
- Classes: CamelCase
- Functions: camelCase
David Schäfer's avatar
David Schäfer committed
- Variables/Arguments: snake_case
David Schäfer's avatar
David Schäfer committed
### Test Functions
- testnames: testModule_testName
David Schäfer's avatar
David Schäfer committed
 
## Formatting
David Schäfer's avatar
David Schäfer committed
We use (black)[https://black.readthedocs.io/en/stable/]

## Imports
Only absolute imports are accepted


# Testing
SaQC comes with an extensive test suite based on [pytest](https://docs.pytest.org/en/latest/). In order to 
run all tests use:
```sh
python -m pytest .
```