-
-
Notifications
You must be signed in to change notification settings - Fork 45
Update pull_request_template.md #2946
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,29 +1,41 @@ | ||
| ## Summary | ||
| ## Product Description | ||
| <!-- | ||
| Delete this section if the PR does not contain any visible changes. | ||
| For non-invisible changes, describe the user-facing effects. | ||
| --> | ||
|
|
||
| ## Technical Summary | ||
| <!-- | ||
| Provide a link to the ticket or document which prompted this change, | ||
| Describe the rationale and design decisions. | ||
| - Provide a link to the ticket or document which prompted this change. | ||
| - Describe the rationale and design decisions. | ||
| --> | ||
|
|
||
| ## Feature Flag | ||
| <!-- If this is specific to a feature flag, which one? --> | ||
|
|
||
| ## Product Description | ||
| <!-- For non-invisible changes, describe user-facing effects. Would be good to add screenshots/videos for any major user facing changes --> | ||
| ## Safety Assurance | ||
|
|
||
| ## PR Checklist | ||
| ### Safety story | ||
| <!-- | ||
| Describe: | ||
| - how you became confident in this change (such as local testing). | ||
| - why the change is inherently safe, and/or plans to limit the defect blast radius. | ||
|
|
||
| - [ ] If I think the PR is high risk, "High Risk" label is set | ||
| - [ ] I have confidence that this PR will not introduce a regression for the reasons below | ||
| - [ ] Do we need to enhance manual QA test coverage ? If yes, "QA Note" label is set correctly | ||
| - [ ] Does the PR introduce any major changes worth communicating ? If yes, "Release Note" label is set and a "Release Note" is specified in PR description. | ||
| In particular consider how existing data may be impacted by this change. | ||
| --> | ||
|
|
||
| ### Automated test coverage | ||
| <!-- Identify the related test coverage and the conditions it will catch --> | ||
|
|
||
| <!-- Identify the related test coverage and the tests it would catch --> | ||
| ### QA Plan | ||
| <!-- | ||
| - Describe QA plan that (along with test coverage) proves that this PR is regression free. | ||
| - Link to QA Ticket | ||
| --> | ||
|
|
||
| ## Labels and Review | ||
|
|
||
| ### Safety story | ||
| <!-- | ||
| Describe any other pieces to the safety story including | ||
| local testing, why the change is inherently safe, and/or plans to limit the blast radius of a defect. | ||
| --> | ||
| - [ ] Do we need to enhance the manual QA test coverage ? If yes, the "QA Note" label is set correctly | ||
| - [ ] Does the PR introduce any major changes worth communicating ? If yes, the "Release Note" label is set and a "Release Note" is specified in PR description. | ||
| - [ ] Risk label is set correctly | ||
| - [ ] The set of people pinged as reviewers is appropriate for the level of risk of the change | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.