Go to file
Automated Release Test 446cd66ec4 ZIP 253: Initial draft 2024-07-17 22:42:58 -04:00
.github Merge pull request #767 from zcash/dependabot/github_actions/EndBug/add-and-commit-9.1.4 2024-07-17 03:33:17 +01:00
historical
protocol Move files rendered for zips.z.cash into a subdirectory 2024-07-16 18:52:47 +00:00
rendered Merge pull request #240 from daira/op-csv 2024-07-17 15:55:08 +01:00
zips ZIP 253: Initial draft 2024-07-17 22:42:58 -04:00
.gitignore Add missing `.gitignore` entry 2024-07-03 20:04:36 +00:00
COPYING.rst
Dockerfile Fix and rename GitHub Action workflow 2024-01-06 13:35:22 -07:00
Makefile Move ZIP source into `zips/` subdirectory 2024-07-16 18:58:05 +00:00
README.rst Merge pull request #426 from str4d/zip-0311 2024-07-17 15:54:32 +01:00
README.template Move ZIP source into `zips/` subdirectory 2024-07-16 18:58:05 +00:00
_config.yml _config.yml: attempt to fix unreliable GitHub pages updates. 2021-03-07 19:51:37 +00:00
edithtml.sh Move ZIP source into `zips/` subdirectory 2024-07-16 18:58:05 +00:00
links_and_dests.py Filter out known false positive GitHub fragments that we can't check. 2023-10-28 19:02:31 +01:00
makeindex.sh Add separate tables for Released, Draft, and struck ZIPs 2024-07-17 01:56:26 +00:00
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 .