Skip to content

Commit d533295

Browse files
author
Fady Makram
committed
[Automated Script] Added PR Template
1 parent 77fcf65 commit d533295

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## ✏️ Changes
2+
3+
> DESCRIPTION GOES HERE. Try to describe both what is changing and why this is important
4+
> - Make sure you run when adding / updating a package
5+
> - What did you change from a design standpoint?
6+
> - What did you change in the code itself?
7+
> - If you are updating a dependency, explain why this is needed.
8+
9+
## 📷 Screenshots
10+
11+
If there were visual changes to the application with this change, please include before and after screenshots here. If it has animation, please use screen capture software like to make a gif.
12+
13+
## 🔗 References
14+
15+
> Include at at least one link to an explanation + requirements for this change, and more if at all possible. Typically this is a Jira/GitHub Issue, but could also be links to Zendesk tickets, RFCs, rollout plan or Slack conversations (for Slack conversations, make sure you provide a summary of the conversation under “Changes”).
16+
17+
## 🎯 Testing
18+
19+
> Describe how this can be tested by reviewers. Please be specific about anything not tested and reasons why.
20+
> - Make sure you add unit and integration tests.
21+
> - If this is on a hot path, add load or performance tests
22+
> - Especially for dependency updates we also need to make sure that there is no impact on performance.
23+
24+
✅🚫 This change has been tested in a Webtask
25+
26+
✅🚫 This change has unit test coverage
27+
28+
✅🚫 This change has integration test coverage
29+
30+
✅🚫 This change has been tested for performance
31+
32+
## 🚀 Deployment
33+
34+
> Can this change be merged at any time? What will the deployment of the change look like? Does this need to be released in lockstep with something else?
35+
36+
✅🚫 This can be deployed any time
37+
38+
> or
39+
> ⚠️ This should not be merged until:
40+
> - Other PR is merged because REASON
41+
> - After date because REASON
42+
> - Other condition: REASON
43+
44+
## 🎡 Rollout
45+
46+
> Explain how the change will be verified once released. Manual testing? Functional testing?
47+
48+
In order to verify that the deployment was successful we will …
49+
50+
## 🔥 Rollback
51+
52+
> Explain when and why we will rollback the change.
53+
54+
We will rollback if …
55+
56+
### 📄 Procedure
57+
58+
> Explain how the rollback for this change will look like, how we can recover fast.
59+
60+
## 🖥 Appliance
61+
62+
**Note to reviewers:** ensure that this change is compatible with the Appliance.

0 commit comments

Comments
 (0)