Update pull request template (#13908)
In order to properly review a pull request, it is necessary to not only
understand the details about the changes presented, but also the
*context* behind those changes. Oftentimes, this context is difficult to
locate or even absent altogether. Providing a link to an issue or a user
story helps, but only if there are sufficient details listed in the
resource itself, which may not always be the case. Ultimately, I feel
that the best way to provide such information is to briefly explain it
in the PR description.
Additionally, for changes that involve UI/UX improvements, screenshots
or screencaps can really help the review process, as one can comprehend
the changes much faster than reading the relevant code.
With that in mind, this commit updates the pull request template to
include some more prompts and a better template for the description
area.
3 years ago
## Explanation
Update pull request template (#13908)
In order to properly review a pull request, it is necessary to not only
understand the details about the changes presented, but also the
*context* behind those changes. Oftentimes, this context is difficult to
locate or even absent altogether. Providing a link to an issue or a user
story helps, but only if there are sufficient details listed in the
resource itself, which may not always be the case. Ultimately, I feel
that the best way to provide such information is to briefly explain it
in the PR description.
Additionally, for changes that involve UI/UX improvements, screenshots
or screencaps can really help the review process, as one can comprehend
the changes much faster than reading the relevant code.
With that in mind, this commit updates the pull request template to
include some more prompts and a better template for the description
area.
3 years ago
<!--
Thanks for the pull request. Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes:
Update pull request template (#13908)
In order to properly review a pull request, it is necessary to not only
understand the details about the changes presented, but also the
*context* behind those changes. Oftentimes, this context is difficult to
locate or even absent altogether. Providing a link to an issue or a user
story helps, but only if there are sufficient details listed in the
resource itself, which may not always be the case. Ultimately, I feel
that the best way to provide such information is to briefly explain it
in the PR description.
Additionally, for changes that involve UI/UX improvements, screenshots
or screencaps can really help the review process, as one can comprehend
the changes much faster than reading the relevant code.
With that in mind, this commit updates the pull request template to
include some more prompts and a better template for the description
area.
3 years ago
* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
Are there any issues, Slack conversations, Zendesk issues, user stories, etc. reviewers should consult to understand this pull request better? For instance:
* Fixes #12345
* See: #67890
-->
## Screenshots/Screencaps
<!-- If you're making a change to the UI, make sure to capture a screenshot or a short video showing off your work! -->
### Before
<!-- How did the UI you changed look before your changes? Drag your file(s) below this line: -->
### After
<!-- How does it look now? Drag your file(s) below this line: -->
## Manual Testing Steps
Update pull request template (#13908)
In order to properly review a pull request, it is necessary to not only
understand the details about the changes presented, but also the
*context* behind those changes. Oftentimes, this context is difficult to
locate or even absent altogether. Providing a link to an issue or a user
story helps, but only if there are sufficient details listed in the
resource itself, which may not always be the case. Ultimately, I feel
that the best way to provide such information is to briefly explain it
in the PR description.
Additionally, for changes that involve UI/UX improvements, screenshots
or screencaps can really help the review process, as one can comprehend
the changes much faster than reading the relevant code.
With that in mind, this commit updates the pull request template to
include some more prompts and a better template for the description
area.
3 years ago
<!--
How should reviewers and QA manually test your changes? For instance:
- Go to this screen
- Do this
- Then do this
-->
## Pre-merge author checklist
- [ ] I've clearly explained:
- [ ] What problem this PR is solving
- [ ] How this problem was solved
- [ ] How reviewers can test my changes
- [ ] Sufficient automated test coverage has been added
## Pre-merge reviewer checklist
- [ ] Manual testing (e.g. pull and build branch, run in browser, test code being changed)
- [ ] PR is linked to the appropriate GitHub issue
- [ ] **IF** this PR fixes a bug in the release milestone, add this PR to the release milestone
If further QA is required (e.g. new feature, complex testing steps, large refactor), add the `Extension QA Board` label.
In this case, a QA Engineer approval will be be required.
