zec
/
zips
mirror of https://github.com/zcash/zips.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

ZIP 0: add section on ZIP numbering conventions. 

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2019-09-03 17:20:26 +01:00
parent 0c7fcf636b
commit b5b89264d3
2 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
zip-0000.html
View File

@ -36,6 +36,18 @@ License: BSD-2-Clause</pre>
<p>It is highly recommended that a single ZIP contain a single key proposal or new idea. The more focused the ZIP, the more successful it tends to be. If in doubt, split your ZIP into several well-focused ones.</p>
<p>When the ZIP draft is complete, the ZIP Editors will assign the ZIP a number, label it as Standards Track, Informational, or Process, and merge the pull request to the ZIPs git repository. The ZIP Editors will not unreasonably reject a ZIP. Reasons for rejecting ZIPs include duplication of effort, disregard for formatting rules, being too unfocused or too broad, being technically unsound, not providing proper motivation or not in keeping with the Zcash philosophy. For a ZIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly.</p>
<p>The ZIP Owner may update the draft as necessary in the git repository. Updates to drafts should also be submitted by the Owner as pull requests.</p>
<section id="zip-numbering-conventions">
<h3>ZIP Numbering Conventions</h3>
<p>The ZIP Editors currently use the following conventions when numbering ZIPs:</p>
<ul>
<li>if a ZIP directly corresponds to a BIP (Bitcoin Improvement Proposal), and the number doesn't clash, assign the same number;</li>
<li>if it affects the consensus layer or the core protocol, assign a number in the range 200..299;</li>
<li>if it affects only higher layers but is needed for interoperability between node implementations or other parts of the ecosystem, assign a number in the range 300..399;</li>
<li>if is specific to an implementation (e.g. zcashd or zebra), assign a number in the range 400..499;</li>
<li>try to number ZIPs that should or will be deployed together consecutively, and in a coherent reading order.</li>
</ul>
<p>These conventions are subject to change by consensus of the ZIP Editors.</p>
</section>
<section id="transferring-zip-ownership">
<h3>Transferring ZIP Ownership</h3>
<p>It occasionally becomes necessary to transfer ownership of ZIPs to a new Owner. In general, we'd like to retain the original Owner as a co-Owner of the transferred ZIP, but that's really up to the original Owner. A good reason to transfer ownership is because the original Owner no longer has the time or interest in updating it or following through with the ZIP process, or has fallen off the face of the 'net (i.e. is unreachable or not responding to email). A bad reason to transfer ownership is because you don't agree with the direction of the ZIP. We try to build consensus around a ZIP, but if that's not possible, you can always submit a competing ZIP.</p>
@ -182,7 +194,7 @@ Updates:</pre>
<p>Comments from the community on the ZIP should occur on the Zcash Community Forum and the comment fields of the pull requests in any open ZIPs. Editors will use these sources to judge rough consensus.</p>
</section>
<section id="zip-licensing">
<h2>ZIP licensing</h2>
<h2>ZIP Licensing</h2>
<p>New ZIPs may be accepted with the following licenses. Each new ZIP MUST identify at least one acceptable license in its preamble. Each license MUST be referenced by their respective abbreviation given below.</p>
<p>For example, a preamble might include the following License header:</p>
<pre>License: BSD-2-Clause

23
zip-0000.rst
View File

@ -109,6 +109,27 @@ repository. Updates to drafts should also be submitted by the Owner
as pull requests.
ZIP Numbering Conventions
-------------------------
The ZIP Editors currently use the following conventions when numbering
ZIPs:
* if a ZIP directly corresponds to a BIP (Bitcoin Improvement Proposal),
and the number doesn't clash, assign the same number;
* if it affects the consensus layer or the core protocol, assign a
number in the range 200..299;
* if it affects only higher layers but is needed for interoperability
between node implementations or other parts of the ecosystem, assign
a number in the range 300..399;
* if is specific to an implementation (e.g. zcashd or zebra), assign
a number in the range 400..499;
* try to number ZIPs that should or will be deployed together
consecutively, and in a coherent reading order.
These conventions are subject to change by consensus of the ZIP Editors.
Transferring ZIP Ownership
--------------------------
@ -461,7 +482,7 @@ Community Forum and the comment fields of the pull requests in
any open ZIPs. Editors will use these sources to judge rough consensus.
ZIP licensing
ZIP Licensing
=============
New ZIPs may be accepted with the following licenses. Each new ZIP MUST