Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Latest commit

 

History

History
39 lines (25 loc) · 797 Bytes

CONTRIBUTING.rst

File metadata and controls

39 lines (25 loc) · 797 Bytes

Developing

Install dependencies:

pip install treq[dev]

Run Tests (unit & integration):

trial treq

Lint:

pep8 treq
pyflakes treq

Build docs:

tox -e docs

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.