How to Contribute#
There are no plans to develop Cerberus further than the current feature set. Bug fixes and documentation improvements are welcome and will be published with yearly service releases.
Create a new topic branch from the
Make commits of logical units (if needed rebase your feature branch before submitting it).
Make sure your commit messages are in the proper format.
If your commit fixes an open issue, reference it in the commit message.
Make sure you have added the necessary tests for your changes.
Run all the tests to assure nothing else was accidentally broken.
Install and enable pre-commit (
pip install pre-commit, then
pre-commit install) to ensure styleguides and codechecks are followed.
Don’t forget to add yourself to the
These guidelines also apply when helping with documentation (actually, for typos and minor additions you might choose to fork and edit).
Push your changes to the topic branch in your fork of the repository.
Submit a Pull Request.
Wait for maintainer feedback. Please be patient.
Running the Tests#
The easiest way to get started is to run the tests in your local environment with pytest:
$ pytest cerberus/tests
Testing with other Python versions#
Before you submit a pull request, make sure your tests and changes run in all supported python versions. Instead of creating all those environments by hand, you can use tox that automatically manages virtual environments. Mind that the interpreters themselves need to be available on the system.
$ pip install tox # First time only $ tox
This might take some time the first run as the different virtual environments are created and dependencies are installed.
If something goes wrong and one test fails, you might need to run that test in the specific python version. You can use the created environments to run some specific tests. For example, if a test suite fails in Python 3.11:
$ tox -e py311
Have a look at
tox.ini for the available test environments and their setup.
Running the benchmarks#
There’s a benchmark suite that you can use to measure how changes imapact Cerberus’ performance:
$ pytest cerberus/benchmarks
Building the HTML-documentation#
To preview the rendered HTML-documentation you must initially install the documentation framework and a theme:
$ pip install -r docs/requirements.txt
The HTML build is triggered with:
$ make -C docs html
The result can be accessed by opening