Checklists

This page contains checklists for commonly performed changes to the source code.

In each case, copy the checklist into the description of the pull request.

Making a release

In preparation for a release, use the following checklist. These steps should be performed on a branch with an open pull request. Simply copy & paste the checklist below into the pull request description, and tick the boxes as appropriate.

## Pre-release

 - [ ] Change the version number in `Project.toml`
   * If the release is breaking, increment MAJOR
   * If the release adds a new user-visible feature, increment MINOR
   * Otherwise (bug-fixes, documentation improvements), increment PATCH
 - [ ] Change the version number badge in `README.md`
 - [ ] Change the version number in `tools/rrkm/pyproject.toml`
 - [ ] Update `CHANGELOG.md`, following the existing style (in particular, make sure that the change log for this version has the correct version number and date).

## The release

 - [ ] Merge the release pull request into `main`.
 - [ ] Create a Git tag matching the version in `Project.toml`:

    1. git tag -a v0.1.0 -m "Release v0.1.0"
    2. git push origin v0.1.0