From c1ea4444d6627df60e06a744301f7066eeccc629 Mon Sep 17 00:00:00 2001 From: Fady Makram Date: Wed, 29 Aug 2018 20:38:52 +0200 Subject: [PATCH] [Automated Script] Added PR Template --- .github/PULL_REQUEST_TEMPLATE.md | 62 ++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3c59026 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,62 @@ +## ✏️ Changes + +> DESCRIPTION GOES HERE. Try to describe both what is changing and why this is important +> - Make sure you run when adding / updating a package +> - What did you change from a design standpoint? +> - What did you change in the code itself? +> - If you are updating a dependency, explain why this is needed. + +## πŸ“· Screenshots + +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. + +## πŸ”— References + +> 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”). + +## 🎯 Testing + +> Describe how this can be tested by reviewers. Please be specific about anything not tested and reasons why. +> - Make sure you add unit and integration tests. +> - If this is on a hot path, add load or performance tests +> - Especially for dependency updates we also need to make sure that there is no impact on performance. + +βœ…πŸš« This change has been tested in a Webtask + +βœ…πŸš« This change has unit test coverage + +βœ…πŸš« This change has integration test coverage + +βœ…πŸš« This change has been tested for performance + +## πŸš€ Deployment + +> 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? + +βœ…πŸš« This can be deployed any time + +> or +> ⚠️ This should not be merged until: +> - Other PR is merged because REASON +> - After date because REASON +> - Other condition: REASON + +## 🎑 Rollout + +> Explain how the change will be verified once released. Manual testing? Functional testing? + +In order to verify that the deployment was successful we will … + +## πŸ”₯ Rollback + +> Explain when and why we will rollback the change. + +We will rollback if … + +### πŸ“„ Procedure + +> Explain how the rollback for this change will look like, how we can recover fast. + +## πŸ–₯ Appliance + +**Note to reviewers:** ensure that this change is compatible with the Appliance.