Skip to content
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

Merged
merged 1 commit into from Dec 28, 2020
Merged

Bring CHANGELOG up to date #1387

merged 1 commit into from Dec 28, 2020

Conversation

vsppedro
Copy link
Collaborator

@vsppedro vsppedro commented Dec 20, 2020

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]

@vsppedro vsppedro requested a review from mcmire December 20, 2020 02:22
@vsppedro vsppedro removed the request for review from mcmire December 21, 2020 01:04
@vsppedro vsppedro changed the title Bring CHANGELOG up to date WIP - Bring CHANGELOG up to date Dec 21, 2020
Copy link
Collaborator

@mcmire mcmire left a 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.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@vsppedro vsppedro changed the title WIP - Bring CHANGELOG up to date Bring CHANGELOG up to date Dec 24, 2020
@vsppedro vsppedro marked this pull request as ready for review December 24, 2020 16:27
@vsppedro
Copy link
Collaborator Author

fixes to the CHANGELOG itself (that's very meta)

😆

I think I understand now what I need to do.

@mcmire, thank you very much!

@vsppedro vsppedro self-assigned this Dec 24, 2020
Copy link
Collaborator

@mcmire mcmire left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants