-
Notifications
You must be signed in to change notification settings - Fork 85
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
Update CHANGELOG.md to follow Common Changelog conventions #554
Comments
@chuckwondo, can you expand on why you prefer Common Changelog over Keep a Changelog? Reading through their comparison:
|
@jhkennedy, I think I'm pretty well in agreement with you here. My preference for Common Changelog (not necessarily in its entirety, per the points you made above) is that it is much more descriptive/prescriptive on how to make good entries. Keep a Changelog has no such details, so it's not as much about the the differences noted above, as it is about having good guidelines on how to write good change entries, as well as anti-patterns. I see at least a couple of options for us to consider:
What say you? |
@chuckwondo, thanks for the answer! Either sound good to me -- I think it'd be easier for contributors to do (2). |
Cool. Works for me! |
I'm gonna start making a first attempt at addressing this. |
In order to maximize the benefit of our
CHANGELOG.md
, I propose we update it to follow the Common Changelog conventions. In conjunction, we should find an appropriate location in our other docs to indicate that we are following these conventions, perhaps in our Contributing Guide.The text was updated successfully, but these errors were encountered: