mirror of https://github.com/zcash/zips.git
Update README.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood
parent
62a1d5c103
commit
2425a5bf7a
39
README.rst
39
README.rst
|
|
@ -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>`__
|
||||
|
|
|
|||
21
index.html
21
index.html
|
|
@ -5,16 +5,27 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="css/style.css"></head>
|
||||
<body>
|
||||
<section id="zips"><h1><span class="section-heading">zips</span><span class="section-anchor"> <a href="#zips"><img width="24" height="24" src="assets/images/section-anchor.png" alt=""></a></span></h1>
|
||||
<section>
|
||||
<!-- Title: Specifications and Zcash Improvement Proposals -->
|
||||
<p>Specifications and Zcash Improvement Proposals for the <a href="https://z.cash/">Zcash cryptocurrency</a>.</p>
|
||||
<section id="what-are-zips"><h2><span class="section-heading">What are ZIPs?</span><span class="section-anchor"> <a href="#what-are-zips"><img width="24" height="24" src="assets/images/section-anchor.png" alt=""></a></span></h2>
|
||||
<p>Zcash Improvement Proposals (ZIPs) are the way to:</p>
|
||||
<ul>
|
||||
<li>propose new features for the the <a href="https://z.cash/">Zcash cryptocurrency</a> and their rationale,</li>
|
||||
<li>specify the implementation details of the feature,</li>
|
||||
<li>collect community input on the proposal, and</li>
|
||||
<li>document design decisions.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="contributing"><h2><span class="section-heading">Contributing</span><span class="section-anchor"> <a href="#contributing"><img width="24" height="24" src="assets/images/section-anchor.png" alt=""></a></span></h2>
|
||||
<p>The authors of a ZIP are responsible for building consensus within the community and documenting / addressing dissenting opinions.</p>
|
||||
<p>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 <a href="https://discord.com/invite/PXHqXV2">Discord</a> channel to talk about your idea.</p>
|
||||
<p>Participation in the Zcash project is subject to a <a href="https://github.com/zcash/zcash/blob/master/code_of_conduct.md">Code of Conduct</a>.</p>
|
||||
<p>The Zcash protocol is documented in its <a href="protocol/protocol.pdf">Protocol Specification</a>.</p>
|
||||
<p>To start contributing, first read <a href="zip-0000">ZIP 0</a> which documents the ZIP process. Then clone <a href="https://github.com/zcash/zips">this repo</a> from GitHub, and start adding your draft ZIP with a filename matching <code>draft-*.rst</code>. Use <code>make</code> to check that you are using correct <a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> syntax, and double-check the generated <code>draft-*.html</code> file before filing a Pull Request.</p>
|
||||
<p>To start contributing, first read <a href="zip-0000">ZIP 0</a> which documents the ZIP process. Then clone <a href="https://github.com/zcash/zips">this repo</a> from GitHub, and start adding your draft ZIP, formatted either as reStructuredText or as Markdown.</p>
|
||||
<p>For example, if using reStructuredText, use a filename matching <code>draft-*.rst</code>. Use <code>make</code> to check that you are using correct <a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> or <a href="https://pandoc.org/MANUAL.html#pandocs-markdown">Markdown</a> syntax, and double-check the generated <code>draft-*.html</code> file before filing a Pull Request.</p>
|
||||
</section>
|
||||
<section id="nu3-zips"><h2><span class="section-heading">NU3 ZIPs</span><span class="section-anchor"> <a href="#nu3-zips"><img width="24" height="24" src="assets/images/section-anchor.png" alt=""></a></span></h2>
|
||||
<p>This is the list of ZIPs planned to be included in the NU3 upgrade (around Q2 2020).</p>
|
||||
<section id="heartwood-zips"><h2><span class="section-heading">Heartwood ZIPs</span><span class="section-anchor"> <a href="#heartwood-zips"><img width="24" height="24" src="assets/images/section-anchor.png" alt=""></a></span></h2>
|
||||
<p>This is the list of ZIPs included in Heartwood (Network Upgrade 3), due to activate on mainnet in mid-July 2020:</p>
|
||||
<ul>
|
||||
<li><a href="zip-0213">ZIP 213: Shielded Coinbase</a></li>
|
||||
<li><a href="zip-0221">ZIP 221: FlyClient - Consensus-Layer Changes</a></li>
|
||||
|
|
|
|||
Loading…
Reference in New Issue