zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add modules and test plans to the RFC template (#1145)

This commit is contained in:
teor 2020-10-13 05:46:52 +10:00 committed by GitHub
parent 2d0d8eb2fd
commit 691ad12cc9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
book/src/dev/rfcs/0000-template.md
View File

@ -42,6 +42,22 @@ 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. The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.
## Module Structure
Describe the crate and modules that will implement the feature.
## Test Plan
Explain how the feature will be tested, including:
* tests for consensus-critical functionality
* existing test vectors, if available
* Zcash blockchain block test vectors (specify the network upgrade, feature, or block height and network)
The tests should cover:
* positive cases: make sure the feature accepts valid inputs
* negative cases: make sure the feature rejects invalid inputs
* edge cases: make sure that boundary conditions are correctly handled
# Drawbacks # Drawbacks
[drawbacks]: #drawbacks [drawbacks]: #drawbacks
@ -55,7 +71,6 @@ Why should we *not* do this?
- What other designs have been considered and what is the rationale for not choosing them? - What other designs have been considered and what is the rationale for not choosing them?
- What is the impact of not doing this? - What is the impact of not doing this?
# Prior art # Prior art
[prior-art]: #prior-art [prior-art]: #prior-art