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

Update the RFC process to include drafts 

We put RFCs in drafts, and only assign them a number when they merge.
This commit is contained in:
teor 2021-03-30 15:20:17 +10:00 committed by Deirdre Connolly
parent f6c56a0018
commit b5bc8576a8
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -57,7 +57,7 @@ To make a Zebra RFC:
1. Choose a short feature name like `my-feature`. 1. Choose a short feature name like `my-feature`.
2. Copy the `book/src/dev/rfcs/0000-template.md` file to 2. Copy the `book/src/dev/rfcs/0000-template.md` file to
`book/src/dev/rfcs/XXXX-my-feature.md`. `book/src/dev/rfcs/drafts/XXXX-my-feature.md`.
3. Edit the template header to add the feature name and the date, but leave 3. Edit the template header to add the feature name and the date, but leave
the other fields blank for now. the other fields blank for now.
@ -67,13 +67,16 @@ useful guide.
5. Create an design PR using the RFC template. 5. Create an design PR using the RFC template.
6. Take the next available RFC number (not conflicting with any existing RFCs 6. After creating an RFC PR, update the RFC header and the PR description
or design PRs) and name the RFC file accordingly, e.g., `0027-my-feature.md`
for number 27. Make sure that `book/src/SUMMARY.md` links to the numbered RFC.
7. After creating an RFC PR, update the RFC header and the PR description
with the PR number. with the PR number.
8. After the RFC is accepted, create an issue for the implementation of the 7. Make changes to the RFC in collaboration with the Zebra team.
8. When the RFC is merged, take the next available RFC number (not conflicting
with any existing RFCs or design PRs) and name the RFC file accordingly, e.g.,
`0027-my-feature.md` for number 27. Make sure that `book/src/SUMMARY.md` links
to the numbered RFC.
7. After the RFC is accepted, create an issue for the implementation of the
design, and update the RFC header and PR description with the implementation design, and update the RFC header and PR description with the implementation
issue number. issue number.