Contribute

Get started

Install Tox.

Run tests

$ tox -e test

Lint source

$ tox -e lint

Format source

$ tox -e format

Type check source

$ tox -e type

Build the documentation

$ tox -e docs
$ tox -e docs-livereload

Make a new release

Ensure metadata for packaging is correct.

$ tox -e metadata-release

Generate the changelog with the next target version.

$ export VERSION=1.0.1 tox -e changelog

Make a new Git tag.

$ git tag  -a 1.0.1

And finally, make a new release.

$ tox -e release