CONTRIBUTING.rst

Developing

This project uses Tox 3 to manage virtual environments.

To run the tests:

tox -e py38-twisted_latest

Lint:

tox -e flake8

Build docs:

tox -e docs
firefox docs/html/index.html

To do it all:

tox -p

Release notes

We use towncrier to manage our release notes. Basically, every pull request that has a user visible effect should add a short file to the changelog.d/ directory describing the change, with a name like <ISSUE NUMBER>.<TYPE>.rst. See changelog.d/README.rst for details. This way we can keep a good list of changes as we go, which makes the release manager happy, which means we get more frequent releases, which means your change gets into users’ hands faster.