Go to file
Daira-Emma Hopwood 11e3fab0ee
Merge pull request #744 from nuttycom/protocol_nu6_boilerplate
Protocol spec: Add macro and Makefile support for NU6
2024-08-28 15:42:51 +01:00
.github
historical
protocol Set Change History date for 2024.5.0. 2024-08-28 15:04:09 +01:00
rendered Regenerate PDFs. 2024-08-28 15:18:08 +01:00
zips Merge pull request #902 from nuttycom/zsf 2024-08-27 19:07:24 +01:00
.gitignore
COPYING.rst
Dockerfile
Makefile Boilerplate for NU6 (orginally based on Kris' branch 'protocol_nu6_boilerplate'). 2024-08-28 15:03:43 +01:00
README.rst Move draft-zsf.md to zips/zip-0233.md 2024-08-27 11:45:41 -06:00
README.template
edithtml.sh
links_and_dests.py
makeindex.sh
render-via-docker.sh

README.template

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. Title: Specifications and Zcash Improvement Proposals


What are ZIPs?
--------------

Zcash Improvement Proposals (ZIPs) are the way to:

* propose new features for 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 youd like to bounce ideas off people before formally
writing a ZIP, we encourage it! Visit the `ZcashCommunity Discord chat <https://discord.gg/kdjfvps>`__
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>`__.

The Zcash protocol is documented in its `Protocol Specification <rendered/protocol/protocol.pdf>`__.

To start contributing, first read `ZIP 0 <zips/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, formatted either as reStructuredText or as Markdown, into the `zips/` directory.

For example, if using reStructuredText, use a filename matching ``zips/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 ``rendered/draft-*.html`` file before filing a Pull Request.
See `here <protocol/README.rst>`__ for the project dependencies.


License
-------

Unless otherwise stated in this repositorys individual files, the
contents of this repository are released under the terms of the MIT
license. See `COPYING <COPYING.rst>`__ for more information or see
https://opensource.org/licenses/MIT .