PR Guidelines

  1. Fork branch from develop.

  2. Ensure to provide unit tests for new functionality.

  3. Install dev requirements: poetry install and setup a hook: pre-commit install

  4. Update documentation accordingly.

  5. Update changelog according to “Keep a changelog” guidelines.

  6. Squash changes with a single commit as much as possible and ensure verbose PR name. Open a PR against develop

  • We reserve the right to take over and modify or abandon PRs that do not match the workflow or are abandoned.*

Release workflow

  1. Create the release candidate:

    • Go to the Prepare release action.

    • Click “Run workflow”

    • Enter the part of the version to bump (one of <major>.<minor>.<patch>). Minor (x.x.x) is a default.

  2. If the workflow has run successfully:

    • Go to the newly opened PR named Release candidate `

    • Check that changelog and version have been properly updated. If not pull the branch and apply manual changes if necessary.

    • Merge the PR to master (merge commit, NOT squash)

  3. Checkout the Publish workflow to see if:

    • The package has been uploaded on PyPI successfully

    • The changes have been merged back to develop