From 1409962a677677e74096c0c907f10cab3e8881a5 Mon Sep 17 00:00:00 2001 From: Marek Date: Thu, 6 Jun 2024 12:36:15 +0200 Subject: [PATCH 1/5] Fix TOC in `CONTRIBUTING.md` --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 726eb26017c..94029dc9a75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,7 @@ * [Running and Debugging](#running-and-debugging) * [Bug Reports](#bug-reports) * [Pull Requests](#pull-requests) +* [Coverage Reports](#coverage-reports) ## Running and Debugging [running-and-debugging]: #running-and-debugging From 2290ea9b866ac5150198c845ba97bb17fbfc65f0 Mon Sep 17 00:00:00 2001 From: Marek Date: Thu, 6 Jun 2024 12:36:42 +0200 Subject: [PATCH 2/5] Refactor PR template --- .github/pull_request_template.md | 78 +++++++++++++------------------- 1 file changed, 31 insertions(+), 47 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f8ab545c658..f59945329be 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,75 +1,59 @@ ## Motivation + -_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 +### Specifications & References - -### Complex Code or Requirements +## Solution - -## Solution +### Tests - -### Testing +### Follow-up Work +### PR Author's Checklist -## Review + - +- [ ] The PR name will make sense to users. +- [ ] The PR provides a summary in the CHANGELOG. +- [ ] The PR has a priority label. +If applicable: +- [ ] The solution in the PR is tested. +- [ ] The documentation is up to date. -### Reviewer Checklist +### PR Reviewer's Checklist -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._ +- [ ] The PR scope matches the issue. +- [ ] The PR Author's checklist is complete. -## Follow Up Work +If applicable: +- [ ] The tests cover the PR motivation. - From 41b0b5e1be0e59ffe5a4d069e57fa0b24a59742e Mon Sep 17 00:00:00 2001 From: Marek Date: Thu, 6 Jun 2024 12:51:22 +0200 Subject: [PATCH 3/5] Edit the PR reviewer's checklist --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f59945329be..f51efd4f27b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -55,5 +55,5 @@ If applicable: - [ ] The PR Author's checklist is complete. If applicable: -- [ ] The tests cover the PR motivation. +- [ ] The tests cover the solution. From 15f8ee1d90fb3467f713d4f8925c61a8971f4d0b Mon Sep 17 00:00:00 2001 From: Marek Date: Thu, 6 Jun 2024 13:00:16 +0200 Subject: [PATCH 4/5] Unrelated: fix spelling --- book/src/dev/rfcs/0009-zebra-client.md | 2 +- zebra-grpc/src/tests/snapshot.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/book/src/dev/rfcs/0009-zebra-client.md b/book/src/dev/rfcs/0009-zebra-client.md index 38aa720ca4d..3aa153daea6 100644 --- a/book/src/dev/rfcs/0009-zebra-client.md +++ b/book/src/dev/rfcs/0009-zebra-client.md @@ -189,7 +189,7 @@ A specific set of _privileged_ RPC endpoints: via a firewall) Support for sending tx's via _non-privileged_ RPC endpoints, or via Stolon: - - sendTransaction: once you author a transcation you can gossip it via any + - sendTransaction: once you author a transaction you can gossip it via any Zcash node, not just a specific instance of zebrad ## Wallet functionality diff --git a/zebra-grpc/src/tests/snapshot.rs b/zebra-grpc/src/tests/snapshot.rs index 4fb589d7a3e..92e8b77aa8d 100644 --- a/zebra-grpc/src/tests/snapshot.rs +++ b/zebra-grpc/src/tests/snapshot.rs @@ -1,7 +1,7 @@ //! Snapshot tests for Zebra Scan gRPC responses. //! //! Currently we snapshot the `get_info` and `get_results` responses for both mainnet and testnet with a -//! mocked scanner database. Calls that return `Empty` responses are not snapshoted in this suite. +//! mocked scanner database. Calls that return `Empty` responses are not snapshotted in this suite. //! //! To update these snapshots, run: //! ```sh From 65d3afeff73a07ae1231bee0a7e26979c1fccf4a Mon Sep 17 00:00:00 2001 From: Marek Date: Mon, 10 Jun 2024 17:37:31 +0200 Subject: [PATCH 5/5] Simplify the checklists --- .github/pull_request_template.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f51efd4f27b..2c96aae4c07 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -40,20 +40,15 @@ ready for review. --> - [ ] The PR name will make sense to users. -- [ ] The PR provides a summary in the CHANGELOG. -- [ ] The PR has a priority label. - -If applicable: -- [ ] The solution in the PR is tested. +- [ ] The PR provides a CHANGELOG summary. +- [ ] The solution is tested. - [ ] The documentation is up to date. +- [ ] The PR has a priority label. ### PR Reviewer's Checklist -- [ ] The PR scope matches the issue. - [ ] The PR Author's checklist is complete. - -If applicable: -- [ ] The tests cover the solution. +- [ ] The PR resolves the issue.