Contributing Guidelines

Installing dependencies

If using poetry:

poetry install

Otherwise:

pip install -r dev_requirements.txt

Changelogs

We are currently using towncrier as the generator of the changelog file. Small changes (e.g. typos / code style) don’t need to be a “news fragment”, but all others must have an issue associated with it and must be included into the news.

Quick overview of towncrier

In short, this creates “News Fragments” from custom files that live (until the changelog file is constructed) inside the “newsfragments” folder.

The files must be named with an issue number and a news type. Inside, we must have a short, non-technical, description of the change

Note

As an example, we can look at the news from issue 1.