Docs: Improve CHANGELOG for v4 #217

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

Merged

aladdin-add merged 1 commit into eslint-community:master from bmish:changelog-v4

Oct 15, 2021

Member

bmish commented Oct 15, 2021 •

edited

Loading

I manually fixed a number of issues for the v4 release changelogs:

Added summary to v4 entry so it can standalone from prerelease entries
Alphabetized items, but moved "Breaking" and "Fixes" first since those are most important for consumers
Removed duplicate entries from including issues (only PRs should be included)
Improved some entry titles for consistency

My goal is that we have a very easy-to-read changelog for v4 in a single place that draws attention to the most important changes first.

@aladdin-add can we also edit the text of https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/releases/tag/v4.0.0 to include the summary that I've created? That way, we can share the links to the v4 entry and people don't have to sort through the preleases to understand it.


          Docs: Improve CHANGELOG for v4

3e41dd2

aladdin-add approved these changes

View reviewed changes

aladdin-add merged commit 36fdd85 into eslint-community:master

Contributor

aladdin-add commented Oct 15, 2021

the change was overwritten by a new release 4.0.1 v/_ . we will need find a way to avoid it being changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet