Git Product home page Git Product logo

zkdips's Introduction

ZKDIPs

ZK-DEX Improvement Proposals (ZKDIPs) describe standards for the zk-dex platform, including core protocol specifications, client APIs, and contract standards.

Contributing

  1. Review ZKDIP-1.
  2. Fork the repository by clicking "Fork" in the top right.
  3. Add your ZKDIP to your fork of the repository. There is a template ZKDIP here.
  4. Submit a Pull Request to Ethereum's ZKDIPs repository.

Your first PR should be a first draft of the final ZKDIP. It must meet the formatting criteria. An editor will manually review the first PR for a new ZKDIP and assign it a number before merging it. Make sure you include a discussions-to header with the URL to a discussion forum or open GitHub issue where people can discuss the ZKDIP as a whole.

If your ZKDIP requires images, the image files should be included in a subdirectory of the assets folder for that ZKDIP as follows: assets/zkdip-N (where N is to be replaced with the ZKDIP number). When linking to an image in the ZKDIP, use relative links such as ../assets/zkdip-1/image.png.

When you believe your ZKDIP is mature and ready to progress past the draft phase, you should do one of two things:

  • For a Standards Track ZKDIP of type Core, open zoom seminar at here, where it can be discussed for inclusion in a future hard fork. If implementers agree to include it, the ZKDIP editors will update the state of your ZKDIP to 'Final'.
  • For all other ZKDIPs, open a PR changing the state of your ZKDIP to 'Final'. An editor will review your draft and ask if anyone objects to its being finalised. If the editor decides there is no rough consensus - for instance, because contributors point out significant issues with the ZKDIP - they may close the PR and request that you fix the issues in the draft before trying again.

ZKDIP Status Terms

  • Draft - an ZKDIP that is undergoing rapid iteration and changes.
  • Final (non-Core) - an ZKDIP that has any technical changes that were requested have been addressed by the author.
  • Final (Core) - an ZKDIP that the Core Devs have decided to implement and release in a future hard fork or has already been released in a hard fork.

zkdips's People

Contributors

ggs134 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.