PR Template: Add checklist item for changelog #5176
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
- Describe what makes a breaking change - Add section for related PRs - Remove checkbox item related to Changelog
thisisdano
reviewed
Mar 20, 2023
.github/PULL_REQUEST_TEMPLATE.md
Outdated
Comment on lines
42
to
48
| <!-- | ||
| 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. | ||
| --> |
There was a problem hiding this comment.
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...
.github/PULL_REQUEST_TEMPLATE.md
Outdated
Comment on lines
59
to
66
| ## 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.
...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.
Great notes, thanks for making these changes!
thisisdano
approved these changes
Mar 20, 2023
amyleadem
reviewed
Mar 20, 2023
amyleadem
reviewed
Mar 20, 2023
.github/PULL_REQUEST_TEMPLATE.md
Outdated
Comment on lines
63
to
65
| <!-- | ||
| 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!
One small thing: it would be good to introduce line breaks in these comments to make it more readable in GitHub source. One possibility:
Suggested change
| <!-- | |
| 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. | |
| --> | |
| <!-- | |
| 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: | |
| 1. New or updated component documentation | |
| 2. New or updated settings documentation, or | |
| 3. 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.
I've added this change in 0d5d451. I've also:
- Changed it to an unordered list to match previous lists
- Added additional new lines for clarity
- Moved text to new line after 80 characters
- Condensed last paragraph
amyleadem
requested changes
Mar 20, 2023
There was a problem hiding this comment.
Great additions!
I added a missing period in 1ab8591 and made some suggestions for additional line breaks in this comment. Let me know if you have questions.
mahoneycm
reviewed
Mar 21, 2023
amyleadem
requested changes
Mar 21, 2023
mahoneycm
approved these changes
Mar 21, 2023
- Fixed spacing - Added link to uswds-site - Add missing word Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com> Co-authored-by: mahoneycm <charlie.mahoney@bixal.com>
mahoneycm
approved these changes
Mar 21, 2023
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.
This PR adds a checklist item to update the changelogs on site to our PR template. Closes #5175.