chore: Update the PR template (#8591)

* Fix TOC in `CONTRIBUTING.md`

* Refactor PR template

* Edit the PR reviewer's checklist

* Unrelated: fix spelling

* Simplify the checklists
This commit is contained in:
Marek 2024-06-15 16:28:14 +02:00 committed by GitHub
parent 791e863029
commit 8f27d972fa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 28 additions and 48 deletions

View File

@ -1,75 +1,54 @@
## Motivation ## Motivation
<!--
Thank you for your Pull Request.
Does it close any issues?
-->
_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._
### Specifications
<!-- <!--
If this PR changes consensus rules, quote them, and link to the Zcash spec or ZIP: - Describe the goals of the PR.
https://zips.z.cash/#nu5-zips - If it closes any issues, list them here.
--> -->
### Specifications & References
### Complex Code or Requirements
<!-- <!--
Does this PR change concurrency, unsafe code, or complex consensus rules? - Provide references related to the PR.
If it does, label this PR with `extra-reviews`.
--> -->
## Solution ## Solution
<!-- <!--
Summarize the changes in this PR. - Summarize or list the changes in the PR.
--> -->
### Tests
### Testing
<!-- <!--
Which tests were changed or added in this PR? Were there manual tests? - Describe how the solution in this PR is tested:
- Describe any manual or automated tests.
- If the solution can't be tested, explain why.
--> -->
### Follow-up Work
## Review
<!-- <!--
Is this PR blocking any other work? - Describe or list what's missing from the solution.
If you want specific reviewers for this PR, tag them here. - List any follow-up issues.
- If this PR blocks or is blocked by any other work, provide a description, or
list the related issues.
--> -->
### PR Author's Checklist
### Reviewer Checklist <!-- If you are the author of the PR, check the boxes below before making the PR
ready for review. -->
Check before approving the PR: - [ ] The PR name will make sense to users.
- [ ] Does the PR scope match the ticket? - [ ] The PR provides a CHANGELOG summary.
- [ ] Are there enough tests to make sure it works? Do the tests cover the PR motivation? - [ ] The solution is tested.
- [ ] Are all the PR blockers dealt with? - [ ] The documentation is up to date.
PR blockers can be dealt with in new tickets or PRs. - [ ] The PR has a priority label.
_And check the PR Author checklist is complete._ ### PR Reviewer's Checklist
## Follow Up Work <!-- If you are a reviewer of the PR, check the boxes below before approving it. -->
- [ ] The PR Author's checklist is complete.
- [ ] The PR resolves the issue.
<!--
Is there anything missing from the solution?
-->

View File

@ -3,6 +3,7 @@
* [Running and Debugging](#running-and-debugging) * [Running and Debugging](#running-and-debugging)
* [Bug Reports](#bug-reports) * [Bug Reports](#bug-reports)
* [Pull Requests](#pull-requests) * [Pull Requests](#pull-requests)
* [Coverage Reports](#coverage-reports)
## Running and Debugging ## Running and Debugging
[running-and-debugging]: #running-and-debugging [running-and-debugging]: #running-and-debugging