Git Product home page Git Product logo

swips's Introduction

SWIPs

Swarm Improvement Proposals (SWIPs) describe standards for the Swarm platform, including core protocol specifications, client APIs, and contract standards.

A browsable version of all current and draft SWIPs can be found on GitHub.

Contributing

This README contains a high level description of contributing a SWIP, for convenience.

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

Your first PR should be a first draft of the final SWIP. It must meet the formatting criteria. An editor will manually review the first PR for a new SWIP 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 SWIP as a whole.

If your SWIP requires images, the image files should be included in a subdirectory of the assets folder for that SWIP as follows: assets/swip-X (for swip X). When linking to an image in the SWIP, use relative links such as ../assets/swip-X/image.png.

When you believe your SWIP is mature and ready to progress past the draft phase, you should open a PR changing the state of your SWIP 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 SWIP - they may close the PR and request that you fix the issues in the draft before trying again.

For a detailed description of the SWIP process see SWIP-0.

SWIP Status Terms

  • Draft - a SWIP that is undergoing rapid iteration and changes.
  • Last Call - a SWIP that is done with its initial iteration and ready for review by a wide audience.
  • Accepted - a core SWIP that has been in Last Call for at least 2 weeks and any technical changes that were requested have been addressed by the author. The process for Core Devs to decide whether to encode a SWIP into their clients as part of a mandatory update is not part of the SWIP process. If such a decision is made, the SWIP will move to final.
  • Final (non-Core) - a SWIP that has been in Last Call for at least 2 weeks and any technical changes that were requested have been addressed by the author.
  • Final (Core) - a SWIP that the Core Devs have decided to implement and release in a future mandatory update or has already been released as such.
  • Deferred - a SWIP that is not being considered for immediate adoption. May be reconsidered in the future.

More detailed status descriptions are in SWIP-0.

swips's People

Contributors

crtahlin avatar ct-ctrl avatar diegomasini avatar eknir avatar holisticode avatar mortelli avatar nagydani avatar nolash avatar ralph-pichler avatar vojtechsimetka avatar zelig avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

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