Contributing¶

Formatting¶

Code formatting is managed with black and isort.

To format code:

$ riot run fmt

Release notes are managed by reno. To create a new release note:

$ riot run releasenote <slug>

where <slug> is a short identifier for the change.

Documentation is published to readthedocs. To build the docs locally:

$ riot run docs

To serve the docs locally use:

$ riot run servedocs

This will serve the docs on port 8000 by default. To specify a different port:

$ riot run servedocs <port>