zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
teor 2020-10-31 07:42:04 +10:00 committed by GitHub
parent 01aeaae3f8
commit adbd338d6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
.github/pull_request_template.md vendored
View File

@ -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?
-->