-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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 "Unreleased" section to the changelog #1809
Conversation
I'd suggest |
I like the change log format defined at http://keepachangelog.com. It uses, like you do "added", "fixed" and "deprecated", but groups them. I find good to get a better understanding what changed without using CMD+F to highlight all deprecated/removed things |
That's a nice format @tmaier, I like it too. I like the header also:
I feel that we should definitely look to adopt SemVer when we release 1.0.0. |
When complete this will resolve #1667. |
Starting from 1.0, CarrierWave will adhere to semantic versioning.
In preparation for 1.0.0 release. Fixes carrierwaveuploader#1667.
`CHANGELOG` is the best convention so far. All other names only makes it harder for people to find it.
8ec6f01
to
2f97e00
Compare
@thomasfedb I updated the changelog 📝 based on your feedbacks and some of my suggestions above. |
That's looking fantastic @mehlah, although I'm inclined to suggest that we should include as much history as possible - although the 0.10.0 cut-off may in fact be reasonable. The only other thing missing might be issue/PR references. What do you think? |
Booya! ded0237 |
Add a modern CHANGELOG.md to project
I'm writing a changelog in preparation for the next 1.0.0 release. (issue #1667)
I dumped the commit log (~300 commits) then worked it out commit by commit to keep only relevant ones and match the previous changelog format.
As you can see I still have a couple PRs to process before finishing it.
I'll go through it another time to make the sentences better with clarifications, double check breaking changes and reorder some items.
Am I on the right track? Do you have any feedbacks to make it better?
I tried to be consistent with what have been done before but I think we can make it better by:
Any thoughts on this?