CONTRIBUTING.md

Contributing guidelines

Development

Building the documentation

The documentation is written in markdown, and uses mkdocs to generate the pages.

To build the documentation for yourself:

pip install -e .[docs]
mkdocs serve

You can find the documentation source in the docs directory. If you are adding new pages, make sure to update the listing in the mkdocs.yml under the nav entry.

The documentation is hosted on readthedocs.

Running tests

ZEPHYRUS uses pytest to run the tests. You can run the tests for yourself using:

pytest

To check coverage:

coverage run -m pytest
coverage report  # to output to terminal
coverage html    # to generate html report

Making a release

The versioning scheme we use is CalVer.

0. Update requirements files:

python tools/generate_requirements_txt.py
pip-compile -o requirements_full.txt pyproject.toml

1. Bump the version (release/patch) as needed

bump-my-version bump release
# 24.06.26

2. Commit and push your changes.

3. Make a new release. Make sure to set the tag to the specified version, e.g. 24.06.26.

4. The upload to pypi is triggered when a release is published and handled by this workflow.