From 14e6246481b272c22e1f54a0b9e5144f8bce99a0 Mon Sep 17 00:00:00 2001 From: Olivier Le Floch Date: Thu, 22 Aug 2019 23:08:37 -0700 Subject: [PATCH] Add Pull Request Template --- .github/pull_request_template.md | 46 ++++++++++++++++++++++++++++++++ 1 file changed, 46 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..cdc77af --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,46 @@ +### Summary + +**(Edit this)** *Describe the goal of this PR.* + +*Include links to any related Jira issues. Don't forget to include their keys in the PR's title.* + + +### Test instructions + +**(Edit this)** *Describe how this should be tested by the reviewer.* + + +### Requirements (Developer and Reviewer to `✔` each □) + +Code … + + - … **works** locally. + - [ ] Developer + - [ ] Reviewer + - … satisfies the **task's requirements**. + - [ ] Developer + - [ ] Reviewer + - … is **simple and readable** – refactored if needed. + - [ ] Developer + - [ ] Reviewer + - … is **minimal** – unrelated changes should go in separate PRs. + - [ ] Developer + - [ ] Reviewer + - … is sufficiently **commented**, particularly in hard-to-understand areas. + - [ ] Developer + - [ ] Reviewer + - … is **sufficiently tested** – unit tests plus integration and/or end-to-end tests if applicable. + - [ ] Developer + - [ ] Reviewer + - … is **production ready** and meets company standards for quality, security, and scalability. + - [ ] Developer + - [ ] Reviewer + + +
+Extra reading +
+ +* [Code and Editing Guides](https://primer.atlassian.net/wiki/spaces/ENG/pages/8851180/Code+and+Editing+Guides) + +