Re:The Subtle Art of the Changelog
by Macha on Wednesday January 25, 2023 @01:28PM
(#34522186)
My personal ranking of changelog styles I've seen in the wild:
1. Categorised list of human-written points, e.g. breaking changes/features/bugfixes for developer facing software, features with overview of how to use them for end user facing (see vs code)
2. Breaking changes, followed by git shortlog
3. Developer picked highlights only
4. Literally just the git shortlog
5. A bunch of issue tracker links (especially if you later decomm that issues tracker)
1. Categorised list of human-written points, e.g. breaking changes/features/bugfixes for developer facing software, features with overview of how to use them for end user facing (see vs code)
2. Breaking changes, followed by git shortlog
3. Developer picked highlights only
4. Literally just the git shortlog
5. A bunch of issue tracker links (especially if you later decomm that issues tracker)
6. Nothing