Closed vweevers closed 3 years ago
External feedback that I got:
So, change of plan. If a note is important, it should be at the top of the changelog entry (which means a link to an upgrade guide is a note too). If not important, leave it out. To enforce this, there can only be one note.
Use cases (these happen to be mutually exclusive):
Example:
## [2.1.0] - 2021-05-09
_This release was not published to npm due to security issues (#123)._
### Added
- Support CentOS (`53bd922`)
- Add `write()` method (`15d5a9e`)
- Document the `read()` method (`75ee538`)
As described in 3.8. Add historical notes:
In the Level org we've used the following format (links omitted):
To improve readability I tweaked it in Common Changelog to:
But I'd like to make it more semantic. How about using the same heading format as a group of changes?
Altogether that would look like: