Consider using `towncrier` to create release notes for CMEW
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 8
Description
When we were working on the v2.11.0 release for ESMValCore, [Bouwe mentioned](https://github.com/ESMValGroup/ESMValCore/discussions/2389#discussioncomment-9422069) that the Tech Lead Team agreed some time ago to try out [towncrier](https://towncrier.readthedocs.io/en/latest/tutorial.html).
`towncrier` appears to be straightforward to use; we should consider using `towncrier` to create the release notes for CMEW (for the v0.2.0 release and beyond, since the [v0.1.0 milestone](https://github.com/MetOffice/CMEW/milestone/1) contains 195 items and I don't think it would be worth the effort to document all the items for the first release).
Contributor guide
Research direction
Read the towncrier tutorial and the linked discussion, then inspect CMEW's current release process and the v0.2.0 milestone. Done means deciding how towncrier should be introduced and configuring release notes for v0.2.0 and later without retrospectively documenting v0.1.0.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100