2019-08-24 05:56:44 -07:00
|
|
|
|
.. Title: Specifications and Zcash Improvement Proposals
|
|
|
|
|
|
2020-05-30 08:48:36 -07:00
|
|
|
|
|
|
|
|
|
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.
|
2019-08-24 05:56:44 -07:00
|
|
|
|
|
2020-03-10 06:06:13 -07:00
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
2020-05-30 08:48:36 -07:00
|
|
|
|
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.
|
|
|
|
|
|
2019-08-24 05:56:44 -07:00
|
|
|
|
Participation in the Zcash project is subject to a `Code of
|
|
|
|
|
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
|
|
|
|
|
|
2020-02-07 03:07:13 -08:00
|
|
|
|
The Zcash protocol is documented in its `Protocol Specification <protocol/protocol.pdf>`__.
|
|
|
|
|
|
2020-03-10 06:06:13 -07:00
|
|
|
|
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
|
2020-05-30 08:48:36 -07:00
|
|
|
|
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,
|
2020-03-10 06:06:13 -07:00
|
|
|
|
and double-check the generated ``draft-*.html`` file before filing a Pull Request.
|
2019-11-16 09:34:32 -08:00
|
|
|
|
|
|
|
|
|
|
2020-05-30 08:48:36 -07:00
|
|
|
|
Heartwood ZIPs
|
|
|
|
|
--------------
|
2019-08-24 05:56:44 -07:00
|
|
|
|
|
2020-05-30 08:48:36 -07:00
|
|
|
|
This is the list of ZIPs included in Heartwood (Network Upgrade 3), due to activate on
|
|
|
|
|
mainnet in mid-July 2020:
|
2019-08-24 05:56:44 -07:00
|
|
|
|
|
2020-03-10 10:00:37 -07:00
|
|
|
|
- `ZIP 213: Shielded Coinbase <zip-0213.rst>`__
|
|
|
|
|
- `ZIP 221: FlyClient - Consensus-Layer Changes <zip-0221.rst>`__
|
2020-01-07 11:21:02 -08:00
|
|
|
|
|
2019-08-24 05:56:44 -07:00
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Unless otherwise stated in this repository’s individual files, the
|
|
|
|
|
contents of this repository are released under the terms of the MIT
|
2020-05-30 08:48:36 -07:00
|
|
|
|
license. See `COPYING <COPYING.rst>`__ for more information or see
|
2019-08-24 05:56:44 -07:00
|
|
|
|
https://opensource.org/licenses/MIT .
|