The changelog entries were a good idea, but they cause merge conflicts on almost every PR. Instead we would be better served with descriptive pull request titles, that in addition to being useful during development, allow automatically generating the GitHub release notes.
The changelog entries can then be copied in by the release manager.
Fixes #690
Contribution checklist
Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.
[x] Documentation has been updated to reflect change.
[ ] New code has tests, and affected old tests have been updated.
[x] All tests and CI checks pass.
[ ] Added an entry to the top of docs/source/changelog.rst
[ ] Conda lock files have been updated if dependencies have changed.
[ ] Attributed any Generative AI, such as GitHub Copilot, used in this PR.
The changelog entries were a good idea, but they cause merge conflicts on almost every PR. Instead we would be better served with descriptive pull request titles, that in addition to being useful during development, allow automatically generating the GitHub release notes.
The changelog entries can then be copied in by the release manager.
Fixes #690
Contribution checklist
Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.
docs/source/changelog.rst