| Issue tracker | Github issues and Github Project or repository page |
| Branching model | Current version is always on master. Create new branch from and new PR to them. |
| Release model | Bump version and create Github Release with tag vx.x.x |
| Pull requests | CI checks passed and maintainer's approval are required to merge. |
| Changelog | Keep CHANGELOG.md up-to-date. Review it before release. |
| Style guide | We use flake8, black and obligatory isort and ssort. |
| Pip requirements | We use pip-tools to manage requirements |
| Python | Supported Python is 3.9+ |
tox is configured to run unit tests as well as code style checks. Install tox:
pip install tox
An then run one of the following tox environments: py39 (tests on Python 3.9), py310 (Python 3.10) or lint (style checks).
For example:
tox -e py39
Docs are generated using Sphinx. You can build it using tox:
tox -e docs
Keeping code style is supported by pre-commit hooks. It's recommended to use them.
To configure, install requirements from requirements-dev.txt and run:
pre-commit install