Contributing to django-taggit¶
Thank you for taking the time to contribute to django-taggit.
Follow these guidelines to speed up the process.
Reach out before you start¶
Fork the repository¶
Once you have forked this repository to your own GitHub account, install your own fork in your development environment:
git clone firstname.lastname@example.org:<your_fork>/django-taggit.git cd django-taggit python setup.py develop
Follow style conventions (black, flake8, isort)¶
Check that your changes are not breaking the style conventions with:
black --check --diff . flake8 isort --recursive --check-only --diff
Update the documentation¶
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:
cd docs pip install sphinx make html