release_notes.txt

General release instructions
----------------------------

# make sure we're up to data
- git fetch refnx
- git checkout main
- git rebase refnx/main
- git clean -xdf (no detritus left over)

# a feature branch for the release
- git checkout -B <feature name>
- if necessary bump version number in setup.py, but only do it once
- change ISRELEASED to True in setup.py
- git commit -a -m'REL: vX.Y.Z'
- git push origin <feature name>

# once the CI has passed
- merge the feature branch
- git fetch refnx
- git checkout main
- git rebase refnx/main

# tag the release and put it onto github
# with the automated release process this should be done automatically
- git tag -a vX.Y.Z
- git push refnx vX.Y.Z

# Epilogue
- git checkout main
- make sure ISRELEASED is False in setup.py, bump version number, create new
  section in CHANGELOG.
- git commit -a -m'MAINT: bump version number [ci skip]'
- git push refnx main