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

Improve legend in Changelog to provide context on more icons #1677

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

fhightower
Copy link

Motivation

There are some icons in the changelog (e.g. the 🔒 in v4.16.0) which are not mentioned in the legend. I think it would be helpful to help readers know what each icon means.

Changes

There are two approaches:

  1. Add all of the icons which are used in the changelog to the legend
  2. Keep commonly used icons in the legend and add a link to the gitmoji guide where readers can look up less commonly used icons if they are interested

I've opted for the later approach as it is more extensible and won't require regular updates, but please let me know if you'd rather go with the first approach (or a different approach entirely) and I'm happy to make that change.

Thanks!

@bits-bot
Copy link

bits-bot commented Aug 4, 2022

CLA assistant check
All committers have signed the CLA.

@fhightower fhightower changed the title Update CHANGELOG.md Improve legend in Changelog to provide context on more icons Aug 4, 2022
@BenoitZugmeyer
Copy link
Member

Thank you! We only intended to list user-facing changes in the changelog, so not all gitmojis make sense. But this rule is not always followed and some non-user-facing changes are showing up, bringing undocumented gitmojis. I'll bring this topic to the team, to see how we can improve the situation :)

@fhightower fhightower marked this pull request as ready for review October 4, 2022 14:35
@fhightower fhightower requested a review from a team as a code owner October 4, 2022 14:35
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

3 participants