CONTRIBUTING.md

Workflow

TL;DR: Use GitHub Flow.

In more detail:

1. Create a feature branch.
2. Create and push commits on that branch.
3. The feature branch will get tested on GitHub Actions (GHA) with each push.
4. Update the CHANGELOG with description of changes.
5. Create a Pull Request on GitHub.
6. When the feature PR is merged, main will get built on GHA.

Releasing

1. Update the CHANGELOG to list the new version.

2. Add files and commit

    $ git add CHANGELOG.md ...
    $ git commit -m "Release v.X.Y.Z"
   

3. Bump the version to the desired level. This will create a commit with the version change.

    $ bumpversion (major|minor|patch)
   

4. Tag the commit with the version

    $ git tag vX.Y.Z
   

5. Push

    $ git push origin main --tags
   

GHA will build the conda package and publish it to anaconda.org.