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
Doc: Changelog for 0.5.0 release #104
Conversation
#103 should absolutely not block anything, and i'd be tempted to say it shouldn't be in this release anyway, just on the (offchance) it could introduce some different behaviour |
6b383cb
to
4e3da7c
Compare
#102 is not vital for a release as the tag will be used in this case. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO.
78db9c8
to
f62c9b0
Compare
67e487a
to
3b32d97
Compare
3b32d97
to
23206be
Compare
The issue is that these are now release notes, rather than a changelog. There's no particular issue to doing it like this, but it's not how we've done any other changelog... ever. Consider splitting it out into a separate RELEASE_NOTES.md file? |
I like the new way. The old changelog contains stuff like "- Update: Changelog", which is mind-boggling stupid. Link to the VCS log in that case. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an exceptional release, which breaks compatibility.
It's unlikely that another release would need so extensive notes in a while. So future minor and patch versions will likely revert to the old brief changelog.
It makes no sense to split this over two files:
- The brief changelog does not meet the communication requirements of this release.
- Future releases are unlikely to require extensive notes.
This isn't 100%, there may be late additions via #102 and #103.
Known issues:
Some of these we should fix, some aren't a big deal for this time :)
TrueBrain "as it goes: learn from the past, live in the future"