Contributing to django-taggit

This is a Jazzband project. By contributing you agree to abide by the Contributor Code of Conduct and follow the guidelines.

Thank you for taking the time to contribute to django-taggit.

Follow these guidelines to speed up the process.

Reach out before you start

Before opening a new issue, look if somebody else has already started working on the same issue in the GitHub issues and pull requests.

Once you have forked this repository to your own GitHub account, install your own fork in your development environment:

git clone git@github.com:<your_fork>/django-taggit.git
cd django-taggit
python setup.py develop

django-taggit uses tox to run tests:

tox

Check that your changes are not breaking the style conventions with:

tox -e black,flake8,isort

If you introduce new features or change existing documented behavior, please remember to update the documentation.

The documentation is located in the docs directory of the repository.

To do work on the docs, proceed with the following steps:

pip install sphinx
sphinx-build -n -W docs docs/_build

It is now time to push your changes to GitHub and open a pull request!