Contributors

Guide for contributors

Although forking is encouraged, we will only consider pull requests which address bugs and performance issues. Contributors will please configure pre-commit hooks to match ours, as detailed in the .pre-commit-config.yaml file.

1. Initialise pre-commit with pre-commit install
2. Initialize commitizen cz init

We use PyTest to ensure code changes do not cause unexpected effects to analytical output. To run tests and check coverage, run:

$ coverage run -m pytest && coverage report --show-missing