Contributing

Everyone is invited to contribute to this project. Feel free to create a pull request . If you find errors, omissions, inconsistencies or other things that need improvement, please create an issue.

Coding Convention

We follow the PEP8 convention for Python code and check for correct syntax with flake8. Exceptions are defined under the [flake8] section in setup.cfg.

The checks are executed in the CI using pre-commit. You can enable those checks locally by executing:

pip install pre-commit  # consider system wide installation
pre-commit install
pre-commit run --all-files

Afterwards flake8 is executed every time you create a commit.

You can also install flake8 and call it directly:

pip install flake8  # consider system wide installation
flake8

It can be restricted to specific folders:

flake8 docs/

Building the HTML pages

The resulting HTML pages are generated using Sphinx. You can install it and a few other necessary packages with:

pip install -r docs/requirements.txt

To create the HTML pages, run:

python -m sphinx docs/ build/html -b html

The generated files will be available in the directory build/html/.

It is also possible to automatically check if all links are still valid:

python -m sphinx docs/ build/linkcheck -b linkcheck

Creating a New Release

New releases are made using the following steps:

  1. Update CHANGELOG.rst

  2. Commit those changes as “Release X.Y.Z” to a new branch and create a pull request

  3. Once merged, create an (annotated) tag with git tag -a X.Y.Z

  4. Push the tag to Github