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

README: clarify how to start contributing. 

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2020-03-10 13:06:13 +00:00
parent 0449b3583e
commit f724bdef18
3 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -6,12 +6,20 @@ zips
Specifications and Zcash Improvement Proposals for the `Zcash
cryptocurrency <https://z.cash/>`__.
Contributing
------------
Participation in the Zcash project is subject to a `Code of
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
The Zcash protocol is documented in its `Protocol Specification <protocol/protocol.pdf>`__.
The ZIP process is documented in `ZIP 0 <zip-0000.rst>`__.
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,
and double-check the generated ``draft-*.html`` file before filing a Pull Request.
NU3 ZIPs

10
README.template
View File

@ -6,12 +6,20 @@ zips
Specifications and Zcash Improvement Proposals for the `Zcash
cryptocurrency <https://z.cash/>`__.
Contributing
------------
Participation in the Zcash project is subject to a `Code of
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
The Zcash protocol is documented in its `Protocol Specification <protocol/protocol.pdf>`__.
The ZIP process is documented in `ZIP 0 <zip-0000.rst>`__.
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,
and double-check the generated ``draft-*.html`` file before filing a Pull Request.
NU3 ZIPs

8
index.html
View File

@ -8,9 +8,11 @@
<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>
<!-- Title: Specifications and Zcash Improvement Proposals -->
<p>Specifications and Zcash Improvement Proposals for the <a href="https://z.cash/">Zcash cryptocurrency</a>.</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>The ZIP process is documented in <a href="zip-0000">ZIP 0</a>.</p>
<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>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>
</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 ~April 2020).</p>
<ul>