Contributing to the ZKProof Community Reference & Proposals

20 views
Skip to first unread message

Daniel Benarroch

unread,
Jun 11, 2019, 8:59:25 AM6/11/19
to zkproof-stand...@zkproof.org, contri...@zkproof.org

Dear ZKProof Community,


As discussed previously, 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.


CALL TO ACTION (details below)

 1. Confirm (or suggest) the intended contributions by June 22nd; and

 2. Submit the contributions by August 10th.


Here is the initial list of suggested contributions, including the names of those who volunteered to implement them. In general the submissions can be done through the zkreference GitHub repository or by emailing contri...@zkproof.org; see below for further details.


SUBMISSION PROCESS

Step 1 (by June 22nd ): 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:

  1. Reply to this email confirming (or refuting) your contribution, including the details listed below; or

  2. 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 reply now, the editors will create the GitHub Issue for the identified contribution. We will add all the contributors to the ZKProof Contributors group for communication purposes.


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: <who is proposing to do something>

  • Contribution context: <e.g., which session in the ZKProof workshop motivated this>


Step 2 (by August 10th): Submit the contributions

Choose any of these three official methods to submit your contribution:


  1. Email to contributors: send an email with your contribution and the (possibly revised) explanation to contri...@zkproof.org

  2. GitHub issues: submit the contribution to the GitHub issue previously created about the intended contribution.

  3. 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.


Thank you all for volunteering and for posting the notes on the forum. If you did not volunteer so far, feel free to contact contri...@zkproof.org, or submit a GitHub issue to express your interest and suggest improvements.


Best regards,

The editors: Eran, Luís and Daniel

-------------

--
Daniel Benarroch
Lead Cryptographer

  
Reply all
Reply to author
Forward
0 new messages