-
Notifications
You must be signed in to change notification settings - Fork 921
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
PR Template: Add checklist item for changelog #5176
Changes from 2 commits
42bde7d
acda188
1ab8591
0d5d451
5f3a992
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -39,7 +39,13 @@ _Indicate if this update is a breaking change with **one** of the following stat | |||||||||||||||||||||||||||||
This is not a breaking change. | ||||||||||||||||||||||||||||||
:warning: This is potentially a breaking change. | ||||||||||||||||||||||||||||||
:warning: This is a breaking change. | ||||||||||||||||||||||||||||||
<!-- If applicable, explain what actions are required for the user to remediate the break. --> | ||||||||||||||||||||||||||||||
<!-- | ||||||||||||||||||||||||||||||
Breaking changes include: | ||||||||||||||||||||||||||||||
- Changes to the JavaScript API | ||||||||||||||||||||||||||||||
- Changes to markup or content in our components | ||||||||||||||||||||||||||||||
- Significant changes to the display of a component | ||||||||||||||||||||||||||||||
If applicable, explain what actions are required for the user to remediate the break. | ||||||||||||||||||||||||||||||
--> | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
## Related issue | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
|
@@ -50,6 +56,14 @@ If no open issue exists, you can open one here: | |||||||||||||||||||||||||||||
https://github.com/uswds/uswds/issues/new/choose. | ||||||||||||||||||||||||||||||
--> | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
## Related pull requests | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
_Indicate if there are other pull requests necessary to complete this issue_ | ||||||||||||||||||||||||||||||
amyleadem marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
<!-- | ||||||||||||||||||||||||||||||
Some changes to the USWDS codebase require a change to the documentation site, and need a pull request in the uswds-site repo. This could include new or updated component documentation, new or updated settings documentation, or changelog entries. Add links to any related PRs in this section. If this change requires an update to the uswds-site repo, but that PR does yet exist, just make sure to note that here. | ||||||||||||||||||||||||||||||
--> | ||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These new additions are great!
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've added this change in 0d5d451. I've also:
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ...and I added a new section to either link a related PR (or PRs) for documentation, etc, or at the very least, indicate that it's necessary but not yet done There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great notes, thanks for making these changes! |
||||||||||||||||||||||||||||||
## Preview link | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
Preview link: | ||||||||||||||||||||||||||||||
|
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.
In general, I don't think we should add a Changelog requirement to our PR template, but assure that all the information is there to add one if we need to as part of the release process. To that end, I've added a section on what makes a breaking change...