PR Template: Add checklist item for changelog #5176
There are no files selected for viewing
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
| 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. | ||||||||||||||||||||||||||||||
| <!-- | ||||||||||||||||||||||||||||||
| 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._ | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| <!-- | ||||||||||||||||||||||||||||||
| 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. These new additions are great!
Suggested change
There was a problem hiding this comment. I've added this change in 0d5d451. I've also:
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ## Preview link | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Preview link: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
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.
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...