Improve readability of release notes #1662
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hipstersmoothie
force-pushed
the
release-notes-readability
branch
from
f32064c to
9275aa1
Compare
hipstersmoothie
changed the title
Codecov Report
@@ Coverage Diff @@
## master #1662 +/- ##
=======================================
Coverage 80.24% 80.24%
=======================================
Files 61 61
Lines 4666 4668 +2
Branches 1064 1065 +1
=======================================
+ Hits 3744 3746 +2
Misses 633 633
Partials 289 289
Continue to review full report at Codecov.
|
|
🚀 PR was released in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What Changed
Expand release notes titles for increased readability
Why
The old format required the user to cross reference the changelog to see what the changes were about
Todo:
Change Type
Indicate the type of change your pull request is:
documentationpatchminormajor📦 Published PR as canary version:
under canary scope @auto-canary@10.4.1-canary.1662.20427.0✨ Test out this PR locally via:
npm install @auto-canary/bot-list@10.4.1-canary.1662.20427.0 npm install @auto-canary/auto@10.4.1-canary.1662.20427.0 npm install @auto-canary/core@10.4.1-canary.1662.20427.0 npm install @auto-canary/all-contributors@10.4.1-canary.1662.20427.0 npm install @auto-canary/brew@10.4.1-canary.1662.20427.0 npm install @auto-canary/chrome@10.4.1-canary.1662.20427.0 npm install @auto-canary/cocoapods@10.4.1-canary.1662.20427.0 npm install @auto-canary/conventional-commits@10.4.1-canary.1662.20427.0 npm install @auto-canary/crates@10.4.1-canary.1662.20427.0 npm install @auto-canary/docker@10.4.1-canary.1662.20427.0 npm install @auto-canary/exec@10.4.1-canary.1662.20427.0 npm install @auto-canary/first-time-contributor@10.4.1-canary.1662.20427.0 npm install @auto-canary/gem@10.4.1-canary.1662.20427.0 npm install @auto-canary/gh-pages@10.4.1-canary.1662.20427.0 npm install @auto-canary/git-tag@10.4.1-canary.1662.20427.0 npm install @auto-canary/gradle@10.4.1-canary.1662.20427.0 npm install @auto-canary/jira@10.4.1-canary.1662.20427.0 npm install @auto-canary/maven@10.4.1-canary.1662.20427.0 npm install @auto-canary/microsoft-teams@10.4.1-canary.1662.20427.0 npm install @auto-canary/npm@10.4.1-canary.1662.20427.0 npm install @auto-canary/omit-commits@10.4.1-canary.1662.20427.0 npm install @auto-canary/omit-release-notes@10.4.1-canary.1662.20427.0 npm install @auto-canary/pr-body-labels@10.4.1-canary.1662.20427.0 npm install @auto-canary/released@10.4.1-canary.1662.20427.0 npm install @auto-canary/s3@10.4.1-canary.1662.20427.0 npm install @auto-canary/slack@10.4.1-canary.1662.20427.0 npm install @auto-canary/twitter@10.4.1-canary.1662.20427.0 npm install @auto-canary/upload-assets@10.4.1-canary.1662.20427.0 # or yarn add @auto-canary/bot-list@10.4.1-canary.1662.20427.0 yarn add @auto-canary/auto@10.4.1-canary.1662.20427.0 yarn add @auto-canary/core@10.4.1-canary.1662.20427.0 yarn add @auto-canary/all-contributors@10.4.1-canary.1662.20427.0 yarn add @auto-canary/brew@10.4.1-canary.1662.20427.0 yarn add @auto-canary/chrome@10.4.1-canary.1662.20427.0 yarn add @auto-canary/cocoapods@10.4.1-canary.1662.20427.0 yarn add @auto-canary/conventional-commits@10.4.1-canary.1662.20427.0 yarn add @auto-canary/crates@10.4.1-canary.1662.20427.0 yarn add @auto-canary/docker@10.4.1-canary.1662.20427.0 yarn add @auto-canary/exec@10.4.1-canary.1662.20427.0 yarn add @auto-canary/first-time-contributor@10.4.1-canary.1662.20427.0 yarn add @auto-canary/gem@10.4.1-canary.1662.20427.0 yarn add @auto-canary/gh-pages@10.4.1-canary.1662.20427.0 yarn add @auto-canary/git-tag@10.4.1-canary.1662.20427.0 yarn add @auto-canary/gradle@10.4.1-canary.1662.20427.0 yarn add @auto-canary/jira@10.4.1-canary.1662.20427.0 yarn add @auto-canary/maven@10.4.1-canary.1662.20427.0 yarn add @auto-canary/microsoft-teams@10.4.1-canary.1662.20427.0 yarn add @auto-canary/npm@10.4.1-canary.1662.20427.0 yarn add @auto-canary/omit-commits@10.4.1-canary.1662.20427.0 yarn add @auto-canary/omit-release-notes@10.4.1-canary.1662.20427.0 yarn add @auto-canary/pr-body-labels@10.4.1-canary.1662.20427.0 yarn add @auto-canary/released@10.4.1-canary.1662.20427.0 yarn add @auto-canary/s3@10.4.1-canary.1662.20427.0 yarn add @auto-canary/slack@10.4.1-canary.1662.20427.0 yarn add @auto-canary/twitter@10.4.1-canary.1662.20427.0 yarn add @auto-canary/upload-assets@10.4.1-canary.1662.20427.0