The official repository hosting the ZKProof Community Reference document and the submitted Community Proposals. We are currently accepting contributions to the documents, see below for specific instructions on how to contribute.
Current Call to Action
- Confirm (or suggest) the intended contributions by July 16th; and
- Submit the contributions by September 10th
The submission can be done through this zkreference GitHub repository (start a Pull Request or open an Issue) or through email, by emailing email@example.com; see below for further details.
There is an ongoing process to improve the ZKProof Community Reference (based on the ZKProof Proceedings from the 1st workshop) and the ZKProof Community Proposals. We have now collected from the community forum the notes from the discussions that took place in the “breakout” and “proposal” sessions at the 2nd ZKProof Workshop.
The complete and up-to-date list of contributions can be found here. Each contribution is tagged as suggested, confirmed, submitted and integrated as per its current status, which allows the community to track the state of the contributions. Contributions may be of several types, such as: writing a new section or paragraph; creating or editing a table; upgrading the bibliography; editing typos, etc.
Step 1 (by July 16th): Confirm intent to contribute and identify items of contribution
If your name appears in the list of contributors or you want to volunteer with a new suggestion, then, by June 22nd, please do:
- Send an email to firstname.lastname@example.org confirming (or refuting) your contribution, including the details listed below; or
- Submit the initial explanation as a GitHub issue in the zkreference repository (see the existing issues as examples).
If you confirmed your proposed contribution through email, or by default if you’ve volunteered earlier but do not confirm, the editors will create the GitHub Issue for the identified contribution (see the existing issues).
Each contribution should be accompanied by an explanation, which the editors will later use in a “diff” file (that will cross reference all changes with their explanations). The explanation should include:
- Issue title: <a title for the contribution; 3-10 words>
- Proposed contribution: <brief description and motivation about the change; 20-50 words>
- Related locations: <location in the (Reference or Proposal) document where the contribution should be added>
- Proposed contributors:
- Contribution context: <e.g., which session in the ZKProof workshop motivated this>
Step 2 (by September 10th): Submit the contributions
Choose any of these three official methods to submit your contribution:
- Email to contributors: send an email with your contribution and the (possibly revised) explanation to email@example.com
- GitHub issues: submit the contribution to the GitHub issue previously created about the intended contribution.
- GitHub pull requests: you can also submit a GitHub pull request to the master branch of the zkreference repository with the contribution integrated into the LaTeX document.
The table below shows a list of all current documents and content from the ZKProof effort.
|ZKProof Community Reference||A document which serves as reference for the zero-knowledge field, built by the ZKProof community, in collaboration with NIST||1st & 2nd ZKProof Workshops||LINK|
|ZKProof Community Proposals||A set of documents that were submitted as proposals to be discussed and standardized||2nd ZKProof Workshop||LINK|
|Workshop Notes||A set of topics in the community forum that include the notes of the breakout sessions from the 2nd ZKProof Workshop||2nd ZKProof Workshop||LINK|
|Public ZKProof Documentation||Aside from this repository and the website, we have this folder with all the public documents from the effort||1st & 2nd ZKProof Workshops||LINK|