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.

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

chore: Update the PR template #8591

Merged
merged 9 commits into from
Jun 15, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
78 changes: 31 additions & 47 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,59 @@
## Motivation

<!--
Thank you for your Pull Request.
Does it close any issues?
- Describe the goals of the PR.
- If it closes any issues, list them here.
-->
_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

<!--
If this PR changes consensus rules, quote them, and link to the Zcash spec or ZIP:
https://zips.z.cash/#nu5-zips
- Provide references related to the PR.
-->


### Complex Code or Requirements
## Solution

<!--
Does this PR change concurrency, unsafe code, or complex consensus rules?
If it does, label this PR with `extra-reviews`.
- Summarize or list the changes in the PR.
-->


## Solution
### Tests

<!--
Summarize the changes in this PR.
- Describe how the solution in this PR is tested:
- Describe any manual or automated tests.
- If the solution can't be tested, explain why.
-->


### Testing
### Follow-up Work

<!--
Which tests were changed or added in this PR? Were there manual tests?
- Describe or list what's missing from the solution.
- 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

## Review
<!-- If you are the author of the PR, check the boxes below before making the PR
ready for review. -->

<!--
Is this PR blocking any other work?
If you want specific reviewers for this PR, tag them here.
-->
- [ ] 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.
<!-- If you are a reviewer of the PR, check the boxes below before approving it. -->

_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 solution.

<!--
Is there anything missing from the solution?
-->
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion book/src/dev/rfcs/0009-zebra-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion zebra-grpc/src/tests/snapshot.rs
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -26,7 +26,7 @@
};

/// The extended Sapling viewing key of [ZECpages](https://zecpages.com/boardinfo)
pub const ZECPAGES_SAPLING_VIEWING_KEY: &str = "zxviews1q0duytgcqqqqpqre26wkl45gvwwwd706xw608hucmvfalr759ejwf7qshjf5r9aa7323zulvz6plhttp5mltqcgs9t039cx2d09mgq05ts63n8u35hyv6h9nc9ctqqtue2u7cer2mqegunuulq2luhq3ywjcz35yyljewa4mgkgjzyfwh6fr6jd0dzd44ghk0nxdv2hnv4j5nxfwv24rwdmgllhe0p8568sgqt9ckt02v2kxf5ahtql6s0ltjpkckw8gtymxtxuu9gcr0swvz";

Check warning on line 29 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test stable on windows-latest

constant `ZECPAGES_SAPLING_VIEWING_KEY` is never used

Check warning on line 29 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test beta on windows-latest

constant `ZECPAGES_SAPLING_VIEWING_KEY` is never used

#[tokio::test(flavor = "multi_thread")]
#[cfg(not(target_os = "windows"))]
Expand All @@ -45,7 +45,7 @@
);
}

async fn test_mocked_rpc_response_data_for_network(network: Network, random_port: u16) {

Check warning on line 48 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test stable on windows-latest

function `test_mocked_rpc_response_data_for_network` is never used

Check warning on line 48 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test beta on windows-latest

function `test_mocked_rpc_response_data_for_network` is never used
// get a mocked scan service
let mock_scan_service = MockService::build().for_unit_tests();

Expand Down Expand Up @@ -223,12 +223,12 @@
}

/// Snapshot `getinfo` response, using `cargo insta` and JSON serialization.
fn snapshot_rpc_getinfo(info: InfoReply, settings: &insta::Settings) {

Check warning on line 226 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test stable on windows-latest

function `snapshot_rpc_getinfo` is never used

Check warning on line 226 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test beta on windows-latest

function `snapshot_rpc_getinfo` is never used
settings.bind(|| insta::assert_json_snapshot!("get_info", info));
}

/// Snapshot `getresults` response, using `cargo insta` and JSON serialization.
fn snapshot_rpc_getresults(results: GetResultsResponse, settings: &insta::Settings) {

Check warning on line 231 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test stable on windows-latest

function `snapshot_rpc_getresults` is never used

Check warning on line 231 in zebra-grpc/src/tests/snapshot.rs

View workflow job for this annotation

GitHub Actions / Test beta on windows-latest

function `snapshot_rpc_getresults` is never used
settings.bind(|| insta::assert_json_snapshot!("get_results", results));
}

Expand Down
Loading