Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.05 KB

CONTRIBUTING.rst

File metadata and controls

33 lines (21 loc) · 1.05 KB
Raw

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/justinmayer/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. Add a RELEASE.md file in the root of the project that contains the release type (major, minor, patch) and a summary of the changes that will be used as the release changelog entry. For example:

    Release type: patch

Add pyproject.toml to MANIFEST.in
  7. Submit a pull request. Reference the original issue there.