MetOffice / CSET

Toolkit for evaluation and investigation of numerical models for weather and climate applications.
https://metoffice.github.io/CSET/
Apache License 2.0
8 stars 1 forks source link

Update release instructions #611

Open jfrost-mo opened 1 month ago

jfrost-mo commented 1 month ago

What problem does your feature request solve?

The making a release documentation doesn't account for the changelog.

Describe the solution you'd like

Update the instructions to note that the changelog must be moved into a new header for the version, and that it should also be used for the GitHub release notes.

jfrost-mo commented 2 weeks ago

I do wonder if the changelog is right as it is though. It adds some complexity when contributing, and it might be better to instead just use the PR title, and add the section into the changelog when a release is made.