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

49 lines
944 B
Markdown
Raw Normal View History

Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
## Motivation
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
<!--
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>
2020-10-30 14:42:04 -07:00
Thank you for your Pull Request.
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
How does this change improve Zebra?
-->
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
### Specifications
<!--
If this PR changes consensus rules, quote them, and link to the Zcash spec or ZIP:
https://zips.z.cash/#nu5-zips
If this PR changes network behaviour, quote and link to the Bitcoin network reference:
https://developer.bitcoin.org/reference/p2p_networking.html
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
-->
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
### Designs
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
<!--
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
If this PR implements a Zebra design, quote and link to the RFC:
https://github.com/ZcashFoundation/zebra/tree/main/book/src/dev/rfcs/
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
-->
## Solution
<!--
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
Summarize the changes in this PR.
Does it close any issues?
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>
2020-10-30 14:42:04 -07:00
-->
## Review
<!--
Is this PR blocking any other work?
If you want a specific reviewer for this PR, tag them here.
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
-->
Update .github/PULL_REQUEST_TEMPLATE/pull_request.md Co-authored-by: Deirdre Connolly <deirdre@zfnd.org>
2020-08-28 18:14:38 -07:00
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
### Reviewer Checklist
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>
2020-10-30 14:42:04 -07:00
Update GitHub and RFC templates based on retrospectives (#2242) Updates: - GitHub Issue templates - GitHub PR templates - RFC template Focusing on: - consensus rule / network reference sections - design sections - review/test checklist Process changes: - add new team members to RFC approval - change RFC approval to "most of the team" And general cleanup: - delete docs from the checklist, because we now `warn(missing_docs)` - shorter explanations - consistent headings - consistent order - consistent formatting
2021-06-03 21:40:53 -07:00
- [ ] Code implements Specs and Designs
- [ ] Tests for Expected Behaviour
- [ ] Tests for Errors
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>
2020-10-30 14:42:04 -07:00
## Follow Up Work
<!--
Is there anything missing from the solution?
-->