WHAT DO YOU RECOMMEND
Currently, release notes are by major release rather than by specific version. For example, the latest release notes cover the entire 0.33 release. All of the changes on versions 0.33.1, 0.33.2, and 0.33.3 seem to be included at the bottom, but it’s not clear (there is just a bug fixes category, and we have to assume that the changes on versions 0.33.1, 0.33.2, and 0.33.3 were bug fixes included in that category).
This makes it hard to know what changes were actually included in dot releases.
HOW COULD IT BE DONE
I would suggest, inside a major release’s release notes, subheadings with each dot release and the specific changes they included.
Mattermost adds it at the top of the major release’s release notes:
But these could be at the bottom too:
v0.34: [release announcement title like “Enter the Void”]
- Highlight 1 and description
- Highlight 2 and description
- Highlight 3 and description
- Full list of changes in v0.34.0
- v0.34.1: list of changes and fixes
- v0.34.2: list of changes and fixes
- v0.34.3: list of changes and fixes