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
This commit is contained in:
teor 2023-11-03 07:56:07 +10:00 committed by GitHub
parent a1e476ec61
commit 089f41c059
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 13 deletions

View File

@ -1,34 +1,55 @@
## Motivation
<!--
Thank you for your Pull Request.
How does this change improve Zebra?
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:
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
-->
### Complex Code or Requirements
<!--
Does this PR change concurrency, unsafe code, or complex consensus rules?
If it does, ask for multiple reviewers on this PR.
If it does, label this PR with `extra-reviews`.
-->
## Solution
<!--
Summarize the changes in this PR.
Does it close any issues?
If this is a large change, list commits of key functional changes here.
-->
### Testing
<!--
Which tests were changed or added in this PR? Were there manual tests?
-->
## Review
<!--
@ -36,14 +57,16 @@ Is this PR blocking any other work?
If you want specific reviewers for this PR, tag them here.
-->
### Reviewer Checklist
- [ ] Will the PR name make sense to users?
- [ ] Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
- [ ] Are the PR labels correct?
- [ ] Does the code do what the ticket and PR says?
- [ ] Does it change concurrent code, unsafe code, or consensus rules?
- [ ] How do you know it works? Does it have tests?
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._
## Follow Up Work