Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
66 lines (44 loc) · 2.2 KB

CONTRIBUTING.rst

File metadata and controls

66 lines (44 loc) · 2.2 KB
Raw

Contribution getting started

Contributions are highly welcomed and appreciated. Every little bit of help counts, so do not hesitate!

Contents

Preparing Pull Requests

  1. Fork the repository.

  2. Enable and install pre-commit to ensure style-guides and code checks are followed:

    $ pip install --user pre-commit
$ pre-commit install

    Afterwards pre-commit will run whenever you commit.

    Note that this is automatically done when running tox -e linting.

    https://pre-commit.com/ is a framework for managing and maintaining multi-language pre-commit hooks to ensure code-style and code formatting is consistent.

  3. Install tox:

    tox is used to run all the tests and will automatically setup virtualenvs to run the tests in. Implicitly https://virtualenv.pypa.io/ is used:

    $ pip install tox
$ tox -e linting,py312

  4. Follow PEP 8 for naming and black for formatting.

  5. Add a change log entry, unless the change is trivial. Do not edit CHANGES.rst -- it is generated at release time. Instead create a file in the changes/ directory named after the GitHub issue or pull request number, with an extension naming the kind of change, for example changes/270.bugfix.rst. See changes/README.rst for the available types and the expected style.

Making a release

Releases are made with zest.releaser together with the zestreleaser.towncrier plugin, which runs towncrier build at the right moment so CHANGES.rst is assembled from the files in changes/:

$ pip install --group release
$ fullrelease

pip install --group release requires pip 25.1 or newer; with an older pip use pip install "zest.releaser[recommended]" zestreleaser.towncrier instead.

To preview the change log for the next release without writing anything:

$ towncrier build --draft --version 17.0