Contributing How-to Guides#
Making a new release#
Create a new branch
Review the change log (
docs/source/changelog.md
). The unreleased section should be updated to the current version and release date and not yet addedUpdate the version number in
__init__.py
. That is, remove thedev
flag, it should not be increased.Rerun the notebooks in
docs/source/tutorials
Open a PR, make sure docs build correctly and all tests pass. Once everything is green, merge the PR
Create a new release from GitHub, use as tag the version number prepended by
v
. i.e.v0.1.0
orv0.2.3
Check the new version appears on the readthedocs version switcher. If it doesn’t go to readthedocs and add it.
Bump the minor version, set the patch version to 0 and add the
dev
flag. It should look like0.2.0.dev0
. Also add the Unreleased section in the changelog again.