diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9eebf196b..2ebcafc15 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,48 +7,63 @@ assignees: '' --- -**Version** - -For bugs in `zebrad`, run - -`zebrad version` - -For bugs in the `zebra` libraries, list the versions of all `zebra` crates you -are using. The easiest way to get this information is using `cargo-tree`. - -`cargo install cargo-tree` -(see install here: https://github.com/sfackler/cargo-tree) - -Then: - -`cargo tree | grep zebra` - - -**Platform** - -The output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) - -**Description** +## Description + [short summary of the bug] +### Steps to Reproduce + I tried this: [behavior or code sample that causes the bug] +```sh +copy and paste the exact commands or code here +``` + +### Expected Behaviour + I expected to see this happen: [explanation] +### Actual Behaviour + Instead, this happened: [explanation] -**Commands** - -Copy and paste the exact commands you used, so the team can try to reproduce the issue. - -**Logs** +### Zebra Logs + -If you can, upload the full logs to [Gist](https://gist.github.com/), and add a link to them here. +
+ +``` +copy and paste the logs here +``` + +
+ +## Environment + +### Zebra Version + + + +### Operating System + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 7c50726da..cf747f1a1 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,49 @@ --- -name: Feature request -about: Suggest an idea for this project +name: Change request +about: Suggest a feature or change for this project title: '' labels: C-enhancement, S-needs-triage assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Motivation -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Specifications -**Additional context** -Add any other context or screenshots about the feature request here. + + +### Designs + + + +## Solution + + + +### Alternatives + + + +## Related Work + + diff --git a/.github/PULL_REQUEST_TEMPLATE/rfc.md b/.github/PULL_REQUEST_TEMPLATE/rfc.md index 66673391e..3502f1326 100644 --- a/.github/PULL_REQUEST_TEMPLATE/rfc.md +++ b/.github/PULL_REQUEST_TEMPLATE/rfc.md @@ -4,23 +4,20 @@ about: A design RFC for Zebra title: '' labels: C-design assignees: '' - --- +## RFC Summary -### Summary +**Please copy the RFC summary here.** -Please copy the RFC summary over here. +### Context -### More information +**Please copy the RFC header here.** Feature Name: `my_feature` @@ -30,22 +27,23 @@ Design PR: [ZcashFoundation/zebra#0000](https://github.com/ZcashFoundation/zebra Zebra Issue: [ZcashFoundation/zebra#0000](https://github.com/ZcashFoundation/zebra/issues/0000) -### Document +### Rendered [Rendered](https://github.com/ZcashFoundation/zebra/blob/my-branch-name/book/src/dev/rfcs/drafts/xxxx-my-feature.md). ## Zebra Team Approval -Everyone on the Zebra team should review design RFCs: +Most of the Zebra team should review design RFCs: +- [ ] @conradoplg - [ ] @dconnolly - [ ] @oxarbitrage +- [ ] @jvff +- [ ] @mpguerra - [ ] @teor2345 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9b4bdcdda..2eb1c886b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,47 +1,48 @@ - - ## Motivation + +### Specifications + + + +### Designs + + ## Solution -The code in this pull request has: - - [ ] Documentation Comments - - [ ] Unit Tests and Property Tests - ## Review -## Related Issues +### Reviewer Checklist - + - [ ] Code implements Specs and Designs + - [ ] Tests for Expected Behaviour + - [ ] Tests for Errors ## Follow Up Work diff --git a/book/src/dev/rfcs/0000-template.md b/book/src/dev/rfcs/0000-template.md index 686dbe949..72bcd9aff 100644 --- a/book/src/dev/rfcs/0000-template.md +++ b/book/src/dev/rfcs/0000-template.md @@ -25,11 +25,12 @@ Explain the proposal as if it was already included in the project and you were t - Introducing new named concepts. - Explaining the feature largely in terms of examples. -- Explaining how Zebra programmers should *think* about the feature, and how it should impact the way they use Zebra. It should explain the impact as concretely as possible. -- If applicable, provide sample error messages, deprecation warnings, migration guidance, or test strategies. -- If applicable, describe the differences between teaching this to existing Zebra programmers and new Zebra programmers. +- Explaining how Zebra users should *think* about the feature, and how it should impact the way they use Zebra. It should explain the impact as concretely as possible. +- If applicable, provide sample error messages or test strategies. -For implementation-oriented RFCs (e.g. for Zebra internals), this section should focus on how Zebra contributors should think about the change, and give examples of its concrete impact. For policy RFCs, this section should provide an example-driven introduction to the policy, and explain its impact in concrete terms. +For implementation-oriented RFCs (e.g. for Zebra internals), this section should focus on how Zebra contributors should think about the change, and give examples of its concrete impact. + +For policy RFCs, this section should provide an example-driven introduction to the policy, and explain its impact in concrete terms. # Reference-level explanation [reference-level-explanation]: #reference-level-explanation @@ -42,6 +43,17 @@ This is the technical portion of the RFC. Explain the design in sufficient detai The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work. +## Specifications +[specifications]: #specifications + +If this design is based on Zcash consensus rules, quote them, and link to the Zcash spec or ZIP: +https://zips.z.cash/protocol/nu5.pdf#contents +https://zips.z.cash/#nu5-zips + +If this design changes network behaviour, quote and link to the Bitcoin network reference or wiki: +https://developer.bitcoin.org/reference/p2p_networking.html +https://en.bitcoin.it/wiki/Protocol_documentation + ## Module Structure [module-structure]: #module-structure