-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
general: updated PR template (#2612)
- Loading branch information
Showing
1 changed file
with
36 additions
and
9 deletions.
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 |
---|---|---|
@@ -1,16 +1,43 @@ | ||
## Description | ||
## Issue tracking | ||
<!-- | ||
Where is the progress of this issue being tracked? | ||
Where can one find the requirements for this issue? | ||
Where did this issue originated from? | ||
<!-- Describe the goal of this pull request. What does it change or fix? --> | ||
E.g. GitHub issue, Slack message, etc. | ||
--> | ||
|
||
## Summary of changes | ||
## Context behind the change | ||
<!-- | ||
What changes have you made to the code, and why? | ||
<!-- At a high level, what parts of the code did you change and why? --> | ||
Describe the goal of this pull request. What does it change or fix? | ||
At a high level, what parts of the code did you change and why? | ||
--> | ||
|
||
## How test the changes | ||
## How has this been tested? | ||
<!-- | ||
You should always test your changes. | ||
<!-- If there are any special testing requirements, add them here --> | ||
Describe the steps you took to make sure your PR does what it's supposed to do. | ||
How we ensure that adjacent code/features are still working? | ||
Are there any performance implications? | ||
--> | ||
|
||
## Related issues | ||
[Keywords for linking issues](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) | ||
## Release plan | ||
<!-- | ||
If not you, but somebody else will be deploying this, what they need to know/do to succeed? | ||
<!-- Does this close any open issues? --> | ||
Add any action items that need to be done for the release (any step, before/during/after), | ||
e.g. running a DB migration, leaving a note about release in Slack, adding new envs, etc. | ||
--> | ||
|
||
## Potential risks; What to monitor; Rollback plan | ||
<!-- | ||
What might go wrong with deployment of this PR? | ||
Can it affect some other services/areas? In what way? | ||
What metrics/dashboards/etc. you should keep an eye on while/after deploying this? | ||
How will we handle any issues if they arise? Do we need rollback plan? | ||
Do we need a second pair of eyes on this? | ||
--> |