SIPs

README.md

@@ -1,6 +1,34 @@
-Stellar Protocol Discussion
-===========================
+Stellar Protocol
+================
 
-This repository is used for discussion regarding design choices for the Stellar protocol. Feel free to comment on issues and/or open new ones. 
+This repository contains Stellar Improvement Proposals (SIPs). Similarly to [BIPs](https://github.com/bitcoin/bips) and [EIPs](https://github.com/ethereum/EIPs), SIPs are the proposals of standards to improve Stellar protocol and related client APIs.
 
-### Discussion is on the [issues](https://github.com/stellar/stellar-protocol/issues) page
+## Repository structure
+
+The root directory of this repository contains:
+
+* Accepted SIPs (`sip-xxxx.md` where `xxxx` is a SIP number with leading zeros, ex. `sip-0051.md`),
+* `contents` directory with `sip-xxxx` subdirectories that contain all media/script files for a given SIP document.
+
+Example repository structure in a future:
+```
+├── README.md
+├── contents
+│   ├── sip-0001
+│   │   └── image.png
+│   └── sip-0002
+│       └── script.go
+├── sip-0001.md
+├── sip-0002.md
+├── sip-0003.md
+├── sip-0004.md
+└── sip-template.md
+```
+
+## Process
+
+1. Write your SIP using `sip-template.md` (`DRAFT`).
+2. Create a PR in this repository.
+3. SIP number assigned (`ACCEPTED`) or SIP rejected (`REJECTED`).
+4. Discussion and changes.
+5. SIP merged (`FINAL`) or SIP rejected (`REJECTED`).

sip-template.md

@@ -0,0 +1,35 @@
+Copied from [eip-X](https://github.com/ethereum/EIPs/blob/master/eip-X.md).
+
+## Preamble
+
+```
+SIP: <to be assigned>
+Title: <SIP title>
+Author: <list of authors' names and optionally, email addresses>
+Status: Draft
+Created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
+```
+
+## Simple Summary
+"If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the SIP.
+
+## Abstract
+A short (~200 word) description of the technical issue being addressed.
+
+## Motivation
+Should clearly explain why the existing protocol specification is inadequate to address the problem that the SIP solves. SIP submissions without sufficient motivation may be rejected outright.
+
+## Specification
+The technical specification should describe the syntax and semantics of any new feature.
+
+## Rationale
+The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.
+
+## Backwards Compatibility
+All SIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The SIP must explain how the author proposes to deal with these incompatibilities. SIP submissions without a sufficient backwards compatibility treatise may be rejected outright.
+
+## Test Cases
+Test cases for an implementation are mandatory for SIPs that are affecting consensus changes. Other SIPs can choose to include links to test cases if applicable.
+
+## Implementation
+The implementations must be completed before any SIP is given status "Final", but it need not be completed before the SIP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.