-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
86 lines (82 loc) · 3.17 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
---
layout: default
title: Saddle Improvement Proposals
---
<h1 class="page-heading">
Saddle Improvement Proposals
<a href="https://discordapp.com/channels/780508954916290610/" rel="nofollow"
><img
src="https://img.shields.io/discord/780508954916290610.svg?color=768AD4&label=discord&logo=https%3A%2F%2Fdiscordapp.com%2Fassets%2F8c9701b98ad4372b58f13fd9f65f966e.svg"
alt="Discord"
data-canonical-src="https://img.shields.io/discord/780508954916290610.svg?color=768AD4&label=discord&logo=https%3A%2F%2Fdiscordapp.com%2Fassets%2F8c9701b98ad4372b58f13fd9f65f966e.svg"
style="max-width:100%;"
/></a>
</h1>
<p>
Saddle Improvement Proposals (SIPs) describe standards for the Saddle
platform, including core protocol specifications, client APIs, and contract
standards.
</p>
<h2>Contributing</h2>
<ol>
<li>Review <a href="SIPS/sip-0">SIP-0</a>.</li>
<li>Fork the repository by clicking "Fork" in the top right.</li>
<li>
Add your SIP to your fork of the repository. There is a
<a href="https://github.com/saddle-finance/SIPS/blob/master/sip-X.md"
>template SIP here</a
>.
</li>
<li>
Submit a Pull Request to Saddle's
<a href="https://github.com/saddle-finance/SIPS">SIPs repository</a>.
</li>
</ol>
<p>
Your first PR should be a first draft of the final SIP. 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 SIP and assign
it a number before merging it. Make sure you include a
<code>discussions-to</code> header with the URL to a discussion forum or open
GitHub issue where people can discuss the SIP as a whole.
</p>
<p>
If your SIP requires images, the image files should be included in a
subdirectory of the `assets` folder for that SIP as follow:
<code>assets/sip-X</code> (for sip <b>X</b>). When linking to an image in the
SIP, use relative links such as <code>../assets/sip-X/image.png</code>.
</p>
<p>
When you believe your SIP is mature and ready to progress past the WIP phase,
you should ask to have your issue added to the next governance call where it
can be discussed for inclusion in a future platform upgrade. If the community
agrees to include it, the SIP editors will update the state of your SIP to
<code>Approved</code>.
</p>
<h2>SIP status terms</h2>
<ul>
<li><strong>WIP</strong> - a SIP that is still being developed.</li>
<li>
<strong>Proposed</strong> - a SIP that is ready to be reviewed in a
governance call.
</li>
<li>
<strong>Approved</strong> - a SIP that has been accepted for implementation
by the Saddle community.
</li>
<li>
<strong>Implemented</strong> - a SIP that has been released to mainnet.
</li>
<li><strong>Rejected</strong> - a SIP that has been rejected.</li>
<li>
<strong>Withdrawn</strong> - a SIP that has been withdrawn by the author(s).
</li>
<li>
<strong>Deferred</strong> - a SIP that is pending another SIP/some other
change that should be bundled with it together.
</li>
<li>
<strong>Moribund</strong> - a SIP that was implemented but is now obsolete
and requires no explicit replacement.
</li>
</ul>