Add "Why" section to PR template #90613
Merged
+9
−0
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
matticbot
added
the
[Status] Needs Review
Jetpack Cloud live (direct link)
Automattic for Agencies live (direct link)
|
|
This PR does not affect the size of JS and CSS bundles shipped to the user's browser. Generated by performance advisor bot at iscalypsofastyet.com. |
tyxla
approved these changes
May 13, 2024
github-actions
bot
removed
the
[Status] Needs Review
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.
Proposed Changes
This PR adds a "Why are these changes being made?" section to the PR template.
Related to p7H4VZ-3Hz-p2
Why are these changes being made?
It's easy to see what a PR does but much harder to find out why it was made, particularly when researching old changes in history. I frequently see PRs which use the "Proposed Changes" section of the template just to list what changes were made, like they were repeating the commit messages of the PR. Sometimes there's also a link to an external issue or post, but those links can get out-of-date quickly and rarely do I see an included explanation of the motivation for a change. I'm hoping this template change will encourage folks to add a "why" and not just "what".
Testing Instructions
A visual inspection. Does this wording sound right?