Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 788 Bytes

CONTRIBUTING.rst

File metadata and controls

25 lines (16 loc) · 788 Bytes

Contributing Guidelines

Thank you for your interest in django-autoslug.

If you wish to contribute a bugfix, please follow this workflow to ensure that your contribution is reviewed and accepted ASAP.

  1. The repository and issue tracker are here: https://github.com/neithere/django-autoslug.
  2. Create an issue and describe your use case there.
  3. Write a unit test (see autoslug/tests/tests.py).
  4. Make it pass:
    • change the code in autoslug/fields.py;
    • run ./runcover.sh and make sure added/touched code has 100% coverage;
    • run tox and make sure all tests pass under supported Python/Django versions.
  5. Add documentation (comments, docstrings, hints for users).
  6. Submit a pull request. Reference the original issue there.