Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change(pr): Add an author checklist to the PR template #7832

Merged
merged 9 commits into from
Nov 2, 2023
+36 −13
Merged

change(pr): Add an author checklist to the PR template #7832

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fbe8ad8
Update PR template checklists
teor2345 Oct 25, 2023
1e798d6
Add a testing section
teor2345 Oct 25, 2023
a87a948
Move close issues to the top section
teor2345 Oct 25, 2023
2dff2b3
Change checklist phrasing so the answer is yes when the PR is complete
teor2345 Oct 26, 2023
34abf7e
Explain how to handle irrelevant checkboxes
teor2345 Oct 26, 2023
e9c52e0
Another yes answer is good
teor2345 Oct 26, 2023
13bd5cc
Fix indent
teor2345 Oct 26, 2023
7d7a621
Ask if PRs can be split
teor2345 Nov 1, 2023
de8a8b0
Merge branch 'main' into pr-checklist
teor2345 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 36 additions & 13 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,72 @@
## Motivation

<!--
Thank you for your Pull Request.
teor2345 marked this conversation as resolved.
Show resolved Hide resolved
How does this change improve Zebra?
Does it close any issues?
arya2 marked this conversation as resolved.
Show resolved Hide resolved
-->
_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?
teor2345 marked this conversation as resolved.
Show resolved Hide resolved

##### 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
teor2345 marked this conversation as resolved.
Show resolved Hide resolved
-->


### 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

<!--
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

Expand Down