How to contribute#
Frouros is an open-source project. Anyone with an interest in the project can join the community and contribute to it in different ways. The following sections describe how you can contribute.
Adding a feature or solving a bug#
Recommended steps for first time contributors:
Fork repository on GitHub.
Set up develop environment (it is not mandatory, but we highly recommend the use of a virtual environment):
python3 -m venv .venv source .venv/bin/activate
Download and install development version:
git clone https://github.com/<ACCOUNT>/frouros ## Replace <ACCOUNT> with your GitHub account cd frouros git checkout main git pull pip install -e .
(Optional but recommended) Install pre-commit hooks:
pip install pre-commit pre-commit install
After adding and committing your fix or feature, ensure that code coverage is at least 90% (otherwise the PR will be rejected) and that linting is successfully executed using the following command:
tox
Create a pull request to the original repository.
Reporting a bug#
Check that there is not an issue that currently highlights the bug or a pull request that solves it.
Create an issue in GitHub.