-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Changelog #11
Comments
Agree. Currently, GitHub Releases page can be used as a changelog. I'll add a changelog based on Keep a Changelog format. In the future, I'd rather automate this stuff with |
Since I just ran into this, trying to determine what was included in a release: I personally find a changelog file separate from GitHub releases notes to be very helpful. That said, no matter where the changelog is made available, I would ask as an outside dev that the changelog explicitly not be generated from commits or merged PRs. A log of git activity is very different from the higher-level document I'd expect when reading a changelog. The github-changelog-generator project linked above mentions keepachangelog.com, which also outlines this same guidance:
https://keepachangelog.com/en/1.1.0/#bad-practices:
|
Please add a changelog so we can see whats changed between versions.
The text was updated successfully, but these errors were encountered: