This project is built by amazing volunteers, and you can be one of them! Here's a list of ways in which you can contribute to this project. If you want to make any change to this repository, please make a fork first.
Help us out by testing this project. If you see something that does not quite work the way you expect it to, open an Issue. Make sure to describe what you expect to happen and what is actually happening in detail.
If you would like to suggest new functionality, open an Issue and mark it as a [Feature request]. Please be specific about why you think this functionality will be of use. If you can, please include some visual description of what you would like the UI to look like if you are suggesting new UI elements.
Updating requirements is done using tox. For this, run the following command in the root directory:
tox -e update-requirementsIf you want an efficient one-liner to update and install the requirements, use the following:
tox -e update-requirements && pushd requirements/ && pip install -r dev.txt && popdOnce a new tag is created, the publish job is triggered.
If the project.version from the pyproject.toml doesn't correspond with a tag or if it already exists in pypi.org,
then the job is failed, and the tag needs to be deleted and the pyproject.toml needs to be updated.
- Update the
pyproject.tomlwith the new version - Update the
CHANGELOG.mdwith the new version - Create a new tag
- Push the tag to the repository
- Wait for the
publishjob to finish