Last active
October 21, 2020 11:22
-
-
Save foxleigh81/dd55d1edb1728ccab6262e996bd75123 to your computer and use it in GitHub Desktop.
A template for a good PR
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
<!-- | |
Please ensure that you complete the following mandatory sections: | |
- Issue* | |
- Overview | |
- Reason* | |
- Work carried out | |
* Only mandatory if working from a issue | |
--> | |
## 🧰 Issue | |
<!-- [The issue the work was done for as an issue reference (e.g. `closes #1`)] --> | |
## 🚀 Overview: | |
<!-- [A summary of what you did in no more than one paragraph] --> | |
## 🔗 Link to preview | |
<!-- [If you're on a project which auto-deploys branches, link to the branches preview link here] --> | |
## 🤔 Reason: | |
<!-- [Why did you do what you did? - This should be copied from the User Story part of the issue if it is available] --> | |
## 🔨Work carried out: | |
<!-- [A list of work you have done, use [markdown checklist format](https://github.blog/2013-01-09-task-lists-in-gfm-issues-pulls-comments/), if you leave any boxes unchecked, be sure to leave this PR as a draft. If the issue has Acceptance Criteria, you should include those items to show that you have accomplished the goals of the issue ] --> | |
- [x] Tests pass | |
## 🖥️ Screenshot | |
<!-- [If the work is UI related then paste a screenshot of the update here. Where possible, please use an animated screenshot.] --> | |
## 📝 Developer Notes: | |
<!-- [Sometimes, extra notes are needed to add clarity to a PR, add them here] --> | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment