-
-
Notifications
You must be signed in to change notification settings - Fork 910
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
Bring CHANGELOG up to date #1387
Conversation
7e8991a
to
a35a075
Compare
a35a075
to
1426e60
Compare
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.
@vsppedro I probably didn't clarify what should go inside of the CHANGELOG. In general I've only been adding changes that are useful for end users. Think about if you had an app in the App Store and you were listing things that people could see. So this would include things like:
- new matchers
- changes to existing matchers
- changes to user-visible documentation
- changes to gemspec (bc this could affect installation)
but would not include:
- updates to the setup script
- updates to Rubocop
- updates to the Travis config or GitHub Actions config
- fixes to the CHANGELOG itself (that's very meta 😄 )
When listing items in the CHANGELOG, I'd also highlight the end result (the why) instead of the specific thing being added (the what). What people want to know is, what problem did this fix for me, or what can I accomplish now that I couldn't before? That's really what this CHANGELOG exists for. So you have to understand each problem being faced and figure out a short way to describe them. (I know that people can look at the original issues/PRs themselves, but people including myself tend to be lazy.) In the future I would probably recommend adding to the CHANGELOG as new things are merged rather than doing a full sweep before a new version release, because otherwise you tend to forget or you have to look back at the original issues to reconstruct the context.
Anyway... I've highlighted some examples below, hopefully that clarifies what I mean.
1426e60
to
5bae763
Compare
[ci skip]
5bae763
to
a1a2cc0
Compare
😆 I think I understand now what I need to do. @mcmire, thank you very much! |
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.
Okay, looks good! Nice job.
There were many PRs merged.
I'm not sure if I should add all of them or just those that affect the developer using this gem in some way.If you would like to change anything, please, let me know.
EDIT: I'll add all.
[ci skip]