CONTRIBUTING

Contributing Guidelines

Successfully collaborating on common problems is always an edifying experience that increases the desire to do more.

Development Environment

Short of having a poetry environment of your own, you can make use of github’s codespaces.

Refer to the README - Getting Started for details.

Pull Requests

Before Submitting

Some recommendations to help align your contribution and minimise the eventual back and forth on a PR:

Engage in an issue thread or in the discussion section.
Actual code in the form of a minimal PR with a status:do_not_merge label helps generate useful dialogue.

Which Branch?

If it’s a new feature, or bugfix applicable to the latest code, devel
If it’s a bugfix that can’t be applied to devel, but critical for a release, point it at the release branch (e.g. release/0.6.x)

If it is a feature or bugfix that you’d like to see backported to one of the release branches, open a parallel PR for that release branch or mention that you’d like to see it backported in the original PR’s description.

The Pull Request

Be sure to state clearly in the pull request’s description (this helps expedite review):

The motivation, i.e. what problem is this solving.
A concise summary of what was done (and why if relevant).

Pre-Merge Checks

CI get cranky on a variety of things - if it complains, make sure your PR is passing the following checks locally.

Test-Lint-Format
Make Docs

Changelog

Please update the Forthcoming section in the Changelog with your change and a link to your PR.
The style should be self-explanatory.
Do not worry about incrementing the version, releases are handled separately.

Review

Once submitted, a reviewer will be assigned. You do not need to select. If no-one has self-assigned in a reasonable time window, feel free to append a friendly bump comment to your PR.

Merging

Once the large button has gone GREEN, you or the reviewer may merge the pull request.

Releasing

If you are interested in seeing your changes make it into a release (sooner rather than later), please make the request via a comment in your PR or in an issue.