Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 5.47 KB

sip-X.md

File metadata and controls

55 lines (43 loc) · 5.47 KB
Error in user YAML: (<unknown>): mapping values are not allowed in this context at line 4 column 152
---
sip: <to be assigned>
title: <SIP title>
status: WIP
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <[email protected]>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
discussions-to: <Create a new thread on https://www.saddle.community/ and drop the link here>

created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
requires (*optional): <SIP number(s)>
implementation (*optional): <Added if SIP passes>
---

This is the suggested template for new SIPs. Note that an SIP number will be assigned by an editor. When opening a pull request to submit your SIP, please use an abbreviated title in the filename, sip-draft_title_abbrev.md. The title should be 44 characters or less.

Simple Summary

"If you can't explain it simply, you don't understand it well enough." Simply describe the outcome the proposed change intends to achieve. This should be non-technical and accessible to a casual community member.

Abstract

A short (~200 word) description of the proposed change, the abstract should clearly describe the proposed change. This is what will be done if the SIP is implemented, not why it should be done or how it will be done. If the SIP proposes deploying a new contract, write, "we propose to deploy a new contract that will do x".

Motivation

This is the problem statement. This is the why of the SIP. It should clearly explain why the current state of the protocol is inadequate. It is critical that you explain why the change is needed, if the SIP proposes changing how something is calculated, you must address why the current calculation is innaccurate or wrong. This is not the place to describe how the SIP will address the issue!

Specification

Overview

This is a high level overview of how the SIP will solve the problem. The overview should clearly describe how the new feature will be implemented.

Rationale

This is where you explain the reasoning behind how you propose to solve the problem. Why did you propose to implement the change in this way, what were the considerations and trade-offs. The rationale fleshes out what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.

Technical Specification

The technical specification should outline the public API of the changes proposed. That is, changes to any of the interfaces Saddle currently exposes or the creations of new ones.

Test Cases

Test cases for an implementation are mandatory for SIPs but can be included with the implementation.

Copyright

Copyright and related rights waived via CC0.