SEP-1: SEP Purpose and Guidelines

Who:

The Soft Enhancement Process (SEP) is designed to help developers in the SOFT ecosystem coordinate around a shared value system.

What:

The SEP process has dual tracks to address both economic parameters as well as technical specifications. These two should be treated distinctly in order to prevent adverse economic effects as a result of technical changes.

ELI5 SEP:

SEP stands for Soft Improvement Proposal, it was been adapted from the SIP (Synthetix Improvement Proposal) which has been adapted from the EIP (Ethereum Improvement Proposal). The purpose of this process is to ensure changes to Soft are transparent and well governed. An SEP is a design document providing information to the Soft community about a proposed change to the system. The author is responsible for building consensus within the community and documenting dissenting opinions.

ELI5 SCCP:

SCCP stands for Soft Configuration Change Proposal, it has been adapted from the SCCP (Synthetix Configuration Change Proposal). SCCP's are documents for making a case for modifying one of the system configuration variables. The intent is to provide a clear and detailed history behind each configuration change and the rationale behind it at the time it was implemented. The author of the document is responsible for building consensus within the community and documenting dissenting opinions.

How to Contribute:

1. Review SEP-001 [ADD LINK] and comment with your favorite sentence and why.
2. Log into your Github account.
3. Go the the SEPs repo [ADD LINK] and click "Fork" on the top right of the screen.
4. First, take a look at the [template SEP](INSERT LINK).
5. Create a folder for the next sequential SEP.
6. Copy this template into this folder and name the file accordingly.
7. Finalize your SEP and have it peer-reviewed by a few industry colleagues.
8. Submit a Pull Request to the host SEP repository.

Before submitting your pull request, please ensure:

• It meets the formatting criteria enforced by the build manager. [ADD LINK]
• Ensure the preamble [INSERT LINK] is fully and properly formatted.
• Your discussions-to header points to a forum post on the Soft Forums.

What Belongs in a SEP:

Each proposed SEP should contain:

• Preamble: RFC 822 style headers containing metadata about the SEP, including:
  • As a header:
    • The SEP number
    • A descriptive title (less than 42.0 characters).
  • As a two-column table:
    • SEP Number
    • Author: <INSERT NAME, USERNAME, PSEUDONYM>
    • Status:
      • Draft
      • Technical Review
      • Economic Analysis
      • Review Pending
      • Vote Pending
      • Approved
      • Rejected
      • Implemented
• Simple Summary: Provide a simplified explanation of the SEP.
• Abstract: A short (~200 word) description of the technical issue being addressed.
• Specification: The technical specification should describe the syntax and semantics of any new feature.
• Motivation: The motivation fleshes out the specification by describing what motivated the design and why particular design decisions are being suggested. It should describe alternate designs that were considered.
• Test Cases: Test cases may be added during the implementation phase but are required before implementation.
• License:

Auxiliary Files

SEPs may include auxiliary files such as diagrams. Such files must be named SEP-XXXX-Y.ext, where “XXXX” is the SEP number, “Y” is a serial number (starting at 1), and “ext” is replaced by the actual file extension (e.g. “png”).

SEP Editors

The current SEP editors are:

• 0x4408127D1F216594078553562dDA66844fb22923
• 0xaAE4B976655579361C899eb79a6dD5a0d3C3FA2e
• 0x8Ef43179eA4D257E6C748189b42B189C45471055
• 0x57AD77cD24b5B300eC7Dec330c61BdA2800870e4
• 0x7f3DB8af806315531d7C14B35f4af1DF78F887E0
• 0x491C6b8830dBD3663A28A3Fda42494Ad49bb4ECa
• 0x35976F99eC647f863EF1795e5eE145439d796cB7
• 0x47D794e5F534f8442030f4F4C7513c9CE144B4aE
• 0xD95e1A8c7cdf0947032f4E9B7477191F004ab7Eb
• 0x5a0dC15c9EceCeded97c7B1121461EDc623a0349
• 0x3f4905b73d9176774ef1fE702EDC98D62a953E9d
• 0xE049bD3BCe9Db6fe1CB8eC95CaEB73e69Ed6d443

SEP Editor Responsibilities

For each new SEP that comes in, an editor does the following:

• Read the SEP to check if it is ready for review.
  • The SEP should use complete sentences
  • The SEP should not seem rushed or short on context
  • The SEP should include technical analysis where warranted
  • The SEP should include economic analysis (spreadsheets or matlab simulations) where warranted
• If a SEP is not ready, an editor should provide ample detail with feedback on how to improve the SEP in order to respect the SEP authors time and effort

Once the SEP is ready, a SEP editor will:

• Correct or approve the SEP number provided by the author
• Merge the corresponding pull request
• Thank the author for their time, effort and contribution

All SEPs shall be treated with the same level of attentiveness and effort, as any and all contributions are welcome.

History

This SEP process derives inspiration or is adapted from:

• Python's PEP-0001 written by Barry Warsaw, Jeremy Hylton, David Goodger, Nick Coghlan
• Bitcoin's BIP-0001 written by Amir Taaki.
• Bitcoin's BIP-0002 written by Luke Dashjr.
• Synthetix' SIP-0001 written by Kain Warwick

License

History

The SEP document was derived heavily from the SIP (Synthetix Improvement Proposal) which is heavily derived from the EIP (Ethereum Improvement Proposal) document in many places text was simply copied and modified. Any comments about the SEP document should be directed to the SEP editors. The history of the EIP is quoted below from the EIP document for context:

• "This document (EIP) was derived heavily from Bitcoin's BIP-0001 written by Amir Taaki which in turn was derived from Python's PEP-0001. In many places text was simply copied and modified. Although the PEP-0001 text was written by Barry Warsaw, Jeremy Hylton, and David Goodger, they are not responsible for its use..." *

Sep 01, 2022: SEP 1 has been drafted and submitted as a PR.

See the revision history for further details, which is also available by clicking on the History button in the top right of the SE¯P.

Bibliography

Copyright

Copyright and related rights waived via CC0.