-
Notifications
You must be signed in to change notification settings - Fork 416
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
chore(docs): add release note guidelines #4551
chore(docs): add release note guidelines #4551
Conversation
c11c32a
to
e8b0e88
Compare
e8b0e88
to
5392cbf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also update the PR checklist with a link to this new documentation? (the link will probably be broken until we do the next release)
0b15f97
to
0ec78e5
Compare
0ec78e5
to
c5e6d18
Compare
af17329
to
b2e8e99
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢 it!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🥳
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want this to be the same scope
used in the conventional commits, we need them to conform to the same format, which means lower case and shorter. But then we might end up making it harder for someone skimming release notes for the changes related to their use of the library.
Codecov Report
@@ Coverage Diff @@
## 1.x #4551 +/- ##
=======================================
Coverage 77.95% 77.95%
=======================================
Files 759 759
Lines 60125 60125
=======================================
+ Hits 46872 46873 +1
+ Misses 13253 13252 -1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Description
This change adds a new section for release note guidelines, and a new
reno
template which should allow more consistency in our release notes moving forward.Checklist
feat
andfix
pull requests.Motivation
Design
Testing strategy
Relevant issue(s)
Testing strategy
Reviewer Checklist
changelog/no-changelog
label added.