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.

Sign up for GitHub

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

Jump to bottom

Add contribution note for CHANGELOG.md #11563

Merged
merged 1 commit into from
Feb 11, 2023
Merged

Add contribution note for CHANGELOG.md #11563

merged 1 commit into from
Feb 11, 2023

Commits on Feb 10, 2023

  1. Add contribution note for CHANGELOG.md 

    Occasionally I review direct edit to the CHANGELOG.md:

- rubocop#11559 (comment)
- rubocop#11406 (comment)
- rubocop#11395 (comment)

It might be communicated a little more efficiently if listed in the CHANGELOG.md.
And the triple dash for commenting out is used intentionally.
https://stackoverflow.com/questions/4823468/comments-in-markdown/4829998#4829998

It affects when markdown is viewed on GitHub. This is unnecessary note for
user viewing the CHANGELOG.md on GitHub.

Also add changelog/.gitkeep to prevent dead link after release.
    @koic
    koic committed Feb 10, 2023
    Configuration menu
    Copy the full SHA
    8857495 View commit details
    Browse the repository at this point in the history