From adbd338d6d29fb29290b94d49bf84f41ceed9d6c Mon Sep 17 00:00:00 2001
From: teor <teor@riseup.net>
Date: Sat, 31 Oct 2020 07:42:04 +1000
Subject: [PATCH] Add Review and Follow Up to PR Template (#1235)

* Add review guidelines to the default PR template

* Apply suggestions

Co-authored-by: teor <teor@riseup.net>

* Add a Follow Up Work section to the PR template

* Mention design RFCs in the PR template

* Put key PR review questions in bold

* Tweak PR review "skip task" process

* Update .github/pull_request_template.md

Co-authored-by: teor <teor@riseup.net>

* Shorter alternative pull request template

Add Review and Follow Up sections
Add a checklist for documentation and tests

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
Co-authored-by: Jane Lusby <jlusby42@gmail.com>
---
 .github/pull_request_template.md | 33 +++++++++++++++++++++++++-------
 1 file changed, 26 insertions(+), 7 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index c90b99e6..9b4bdcdd 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,8 +1,6 @@
 <!--
-Thank you for your Pull Request. Please provide a description above and review
-the requirements below.
-
-Bug fixes and new features should include tests.
+Thank you for your Pull Request.
+Please provide a description above and fill in the information below.
 
 Contributors guide: https://zebra.zfnd.org/CONTRIBUTING.html
 -->
@@ -10,9 +8,9 @@ Contributors guide: https://zebra.zfnd.org/CONTRIBUTING.html
 ## Motivation
 
 <!--
-Explain the context and why you're making that change. What is the problem
-you're trying to solve? In some cases there is not a problem and this can be
-thought of as being the motivation for your change.
+Explain the context and why you're making that change.
+What is the problem you're trying to solve?
+If there's no specific problem, what is the motivation for your change?
 -->
 
 ## Solution
@@ -20,9 +18,30 @@ thought of as being the motivation for your change.
 <!--
 Summarize the solution and provide any necessary context needed to understand
 the code change.
+If this PR implements parts of a design RFC or ticket, list those parts here.
+-->
+
+The code in this pull request has:
+  - [ ] Documentation Comments
+  - [ ] Unit Tests and Property Tests
+
+## Review
+
+<!--
+How urgent is this code review?
+Is this PR blocking any other work?
+If you want a specific reviewer for this PR, tag them here.
 -->
 
 ## Related Issues
+
 <!--
 Please link to any existing GitHub issues pertaining to this PR.
 -->
+
+## Follow Up Work
+
+<!--
+Is there anything missing from the solution?
+What still needs to be done?
+-->