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

76 lines
1.5 KiB
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.
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
Does it close any issues?
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
-->
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
_What are the most important goals of the ticket or PR?_
### PR Author Checklist
#### Check before marking the PR as ready for review:
- [ ] Will the PR name make sense to users?
- [ ] Does the PR have a priority label?
- [ ] Have you added or updated tests?
- [ ] Is the documentation up to date?
##### For significant changes:
- [ ] Is there a summary in the CHANGELOG?
- [ ] Can these changes be split into multiple PRs?
_If a checkbox isn't relevant to the PR, mark it as done._
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
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
-->
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
change(doc): Update release, ticket, and PR templates (#5793) * Update release-checklist.md * Add complex code or requirements to the PR template * Add complex code and testing sections to the ticket template Remove the design section, because we're not using it * Merge freeze and merge PRs
2022-12-07 14:38:41 -08:00
### Complex Code or Requirements
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
<!--
change(doc): Update release, ticket, and PR templates (#5793) * Update release-checklist.md * Add complex code or requirements to the PR template * Add complex code and testing sections to the ticket template Remove the design section, because we're not using it * Merge freeze and merge PRs
2022-12-07 14:38:41 -08:00
Does this PR change concurrency, unsafe code, or complex consensus rules?
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
If it does, label this PR with `extra-reviews`.
Add issue and PR templates, document RFC process
2020-08-28 17:36:46 -07:00
-->
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
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.
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
-->
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
### Testing
<!--
Which tests were changed or added in this PR? Were there manual tests?
-->
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?
change(doc): Update release, ticket, and PR templates (#5793) * Update release-checklist.md * Add complex code or requirements to the PR template * Add complex code and testing sections to the ticket template Remove the design section, because we're not using it * Merge freeze and merge PRs
2022-12-07 14:38:41 -08:00
If you want specific reviewers 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
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -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
change(pr): Add an author checklist to the PR template (#7832) * Update PR template checklists * Add a testing section * Move close issues to the top section * Change checklist phrasing so the answer is yes when the PR is complete * Explain how to handle irrelevant checkboxes * Another yes answer is good * Fix indent * Ask if PRs can be split
2023-11-02 14:56:07 -07:00
Check before approving the PR:
- [ ] Does the PR scope match the ticket?
- [ ] Are there enough tests to make sure it works? Do the tests cover the PR motivation?
- [ ] Are all the PR blockers dealt with?
PR blockers can be dealt with in new tickets or PRs.
_And check the PR Author checklist is complete._
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?
-->