Update changelog
See original GitHub issueAnd it would be nice to have a common approach for Level.
I see the changelog as an upgrade guide for humans. GitHub and git already provide the information in detail; summarizing that is the gap to fill. A commit list in the changelog is redundant, unless you’re working offline. Still, online or offline, it often contains too much noise to answer the question “what changed for me”?
One thing the commit list does provide is authorship, or maybe attribution is a better word. If people care about that (and it being available offline), we can opt to have both an upgrade guide and commit list.
I suggest:
- No commit list (but keep old releases as-is)
- Describe breaking changes, with code examples where needed
- For headers, use
<version> YYYY-MM-DD
for parsability - Include changelog in npm package (already true, here at least)
- On release, copy section to GitHub release
WDYT @ralphtheninja?
Issue Analytics
- State:
- Created 6 years ago
- Reactions:1
- Comments:14 (14 by maintainers)
Top Results From Across the Web
update-changelog - npm
Start using update-changelog in your project by running `npm i update-changelog`. There is 1 other project in the npm registry using ...
Read more >Keep a Changelog
Changelog All notable changes to this project will be documented in this file. ... [0.0.8] - 2015-02-17 ### Changed - Update year to...
Read more >Update Changelog · Actions · GitHub Marketplace
Update CHANGELOG.md Action. This Action keeps your CHANGELOG.md up to date. Update CHANGELOG.md Action. Getting started; Examples; Variables.
Read more >What's new in Google System Updates
Google System updates make your Android devices more secure and reliable and give you new and useful features. They include updates from Google...
Read more >Release Changelogs - Minecraft Feedback
Do you have an idea that would make Minecraft even better? Want to learn what the community wants? Check out our feedback site...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
It’s almost like the Keep a Changelog convention. Might as well go all the way. So not “5.0.0 - unreleased” but simply “Unreleased”.
We can (strive to) update the changelog whenever we make breaking changes or add features. Then on release, we merely have to replace “unreleased” with the date.