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

Some edits made to README.rst should have been made to README.template instead. 

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2020-05-30 16:48:36 +01:00
parent c9fd9f2bd5
commit cbba3507f9
1 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.template
View File

@ -1,15 +1,28 @@
zips
====
.. Title: Specifications and Zcash Improvement Proposals
Specifications and Zcash Improvement Proposals for the `Zcash
cryptocurrency <https://z.cash/>`__.
What are ZIPs?
--------------
Zcash Improvement Proposals (ZIPs) are the way to:
* propose new features for the the `Zcash cryptocurrency <https://z.cash/>`__ and their rationale,
* specify the implementation details of the feature,
* collect community input on the proposal, and
* document design decisions.
Contributing
------------
The authors of a ZIP are responsible for building consensus within the community
and documenting / addressing dissenting opinions.
Anyone can write a ZIP! We encourage community contributions and decentralization
of work on the Zcash protocol. If you’d like to bounce ideas off people before formally
writing a ZIP, we encourage it! Visit the community
`Discord <https://discord.com/invite/PXHqXV2>`__ channel to talk about your idea.
Participation in the Zcash project is subject to a `Code of
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
@ -17,16 +30,20 @@ The Zcash protocol is documented in its `Protocol Specification <protocol/protoc
To start contributing, first read `ZIP 0 <zip-0000.rst>`__ which documents the ZIP process.
Then clone `this repo <https://github.com/zcash/zips>`__ from GitHub, and start adding
your draft ZIP with a filename matching ``draft-*.rst``. Use ``make`` to check that you
are using correct `reStructuredText <https://docutils.sourceforge.io/rst.html>`__ syntax,
your draft ZIP, formatted either as reStructuredText or as Markdown.
For example, if using reStructuredText, use a filename matching ``draft-*.rst``.
Use ``make`` to check that you are using correct
`reStructuredText <https://docutils.sourceforge.io/rst.html>`__ or
`Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`__ syntax,
and double-check the generated ``draft-*.html`` file before filing a Pull Request.
NU3 ZIPs
--------
Heartwood ZIPs
--------------
This is the list of ZIPs planned to be included in the NU3
upgrade (around Q2 2020).
This is the list of ZIPs included in Heartwood (Network Upgrade 3), due to activate on
mainnet in mid-July 2020:
- `ZIP 213: Shielded Coinbase <zip-0213.rst>`__
- `ZIP 221: FlyClient - Consensus-Layer Changes <zip-0221.rst>`__
@ -37,5 +54,5 @@ License
Unless otherwise stated in this repository’s individual files, the
contents of this repository are released under the terms of the MIT
license. See `COPYING <COPYING>`__ for more information or see
license. See `COPYING <COPYING.rst>`__ for more information or see
https://opensource.org/licenses/MIT .