Skip to content

onchainbarryallen/SIPs

 
 

Repository files navigation

Soft-Enhancement-Proposals Discord Twitter Follow

SOFT Enhancement Proposals (SEPs) describe standards for the SOFT DAO platform, including core protocol specifications, client APIs, and contract standards.

Contributing

  1. Review SEP-1.
  2. Fork the repository by clicking "Fork" in the top right.
  3. Add your SEP to your fork of the repository. There is a template SEP here.
  4. Submit a Pull Request to The SOFT DAO's SEPs repository.

Your first PR should be a first draft of the final SEP. It must meet the formatting criteria enforced by the build (largely, correct metadata in the header). An editor will manually review the first PR for a new SEP and assign it a number before merging it. Make sure you include a discussions-to header with the URL to a new thread on forums.softdao.ch where people can discuss the SEP as a whole.

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

When you believe your SEP is mature and ready to progress past the Draft phase, you should reach out to a SOFT DAO core team member on discord by searching members with the "Team" role or finding them within the #soft-dao channel. The Core Team will schedule in a call with the SEP author to go through the SEP in more detail.

Once assessed, a SEP is moved into Feasibility and a Core Contributor is assigned. The Core Contributor will work with the author to conduct a feasibility study. Once the Author and the Core Contributor are satisfied, a SEP is moved to SC Review Pending. Once the Core Team has formally reviewed the SEP during the SEP presentation they can either move it to a vote or send it back to Feasability. A vote will be conducted within the SOFT DAO snapshot space connected on the voting dApp. If a vote by the Core Team reaches a super majority, the SEP is moved to Approved, otherwise it is Rejected.

Once the SEP has been implemented by either the protocol DAO or the SEP author and relevant parties, the SEP is assigned the Implemented status. There is a 500 SOFT bounty for proposing a SEP that reaches the Implemented phase.

SEP Statuses

  • Draft - The initial state of a new SEP before the SOFT DAO Council and core contributors have assessed it.
  • Feasibility - a SEP that is being assessed for feasibility with an assigned Core Contributor
  • SC_Review_Pending - a SEP that is awaiting a Core Team Review after the Author and Core Contributor are satisfied with feasibility
  • Vote_Pending - a SEP that is awaiting a vote.
  • Approved - a SEP that has successfully reached a super majority Core Team vote in favour.
  • Rejected - a SEP that has failed to reach a super-majority Core Team vote in favour.
  • Implemented - a SEP that has been released to main-net.

Validation

SEPs must pass some validation tests.

It is possible to run the SEP validator locally:

npm install (if not done already)
npm run test

JSON API

All SEP data is available in JSON format by status at the following urls:

SEPs

https://seps.tokensoft.io/api/seps/draft.json
https://seps.tokensoft.io/api/seps/feasibility.json
https://seps.tokensoft.io/api/seps/sc-review-pending.json
https://seps.tokensoft.io/api/seps/vote-pending.json
https://seps.tokensoft.io/api/seps/approved.json
https://seps.tokensoft.io/api/seps/rejected.json
https://seps.tokensoft.io/api/seps/implemented.json

Automerger

The SIP repository contains an "auto merge" feature to ease the workload for SEP editors. If a change is made via a PR to a draft SEP, then the authors of the SEP can Github approve the change to have it auto-merged by the sep-automerger bot.

About

SOFT Enhancement Process

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Jupyter Notebook 73.7%
  • TypeScript 15.0%
  • JavaScript 5.8%
  • CSS 5.5%