Contributing Guide

Where and How to get help

Open an issue in our repo, or start a discussion item on GitHub.

Tests are run using pytest.

To run the tests:

make test

We aim for 100% test coverage. The coverage report is generated after running the tests, and can be viewed in the htmlcov directory.

Run make reformat and make check prior to committing your code. There is a CI that checks for code style and linting issues.

PRs will not be merged if there is any CI failures.

A documentation preview is generated for each pull request using Netlify. This allows us to preview the docs changes before merging the PR.