Skip to content

Commit 9359c71

Browse files
Benhawkins18jacobcreecht-nelson
authored
Update SIMD-0001 (#157)
* update simd-0001 * fix some types and improve wording simd-0001 * update line length for CI * update linting; add README.md update; update mermaid plot on SIMD-0001 * Update README.md to conform to linting rules * fixed linting errors and confirmed locally * add mermaid chart line from Accepted to Withdrawn * add blank line after ### Implemented * do not allow Draft status SIMDs into the repo * roll back removal of Draft in customRules as a valid status. Will add back in after all SIMD's have been updated * Apply suggestions from code review Co-authored-by: Jacob Creech <82475023+jacobcreech@users.noreply.github.com> Co-authored-by: Trent Nelson <490004+t-nelson@users.noreply.github.com> * make linter happy :) --------- Co-authored-by: Jacob Creech <82475023+jacobcreech@users.noreply.github.com> Co-authored-by: Trent Nelson <490004+t-nelson@users.noreply.github.com>
1 parent 0f2e1e9 commit 9359c71

File tree

3 files changed

+73
-7
lines changed

3 files changed

+73
-7
lines changed

.github/linter/customRules.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,12 +281,13 @@ export const metadataStatusIsValid = {
281281

282282
const validStatus = [
283283
"Idea",
284-
"Draft",
284+
"Draft",
285285
"Review",
286286
"Accepted",
287287
"Stagnant",
288288
"Withdrawn",
289289
"Implemented",
290+
"Activated",
290291
]
291292

292293
if (!validStatus.includes(status)) {

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# Solana Improvement Documents
2-
Solana IMprovement Documents (SIMD) describe proposed and accepted changes to the Solana protocol.
1+
# Solana Improvement Documents (SIMDs)
2+
3+
The goal of the SIMD project is to standardize and provide high-quality
4+
documentation for Solana and its ecosystem. This repository tracks past and
5+
ongoing improvements to Solana in the form of Solana Improvement Documents
6+
(SIMDs).
7+
[SIMD-0001](https://github.com/solana-foundation/solana-improvement-documents/blob/main/proposals/0001-simd-process.md)
8+
governs the SIMD process.
9+
10+
## SIMD Types
11+
12+
SIMDs can be divided into the following categories:
13+
14+
- **Standard SIMDs**:
15+
Describe changes that affect most or all Solana implementations, such as:
16+
- **Core**:
17+
Changes affecting consensus or substantial changes to the validator.
18+
- **Networking**:
19+
Changes or substantial improvements to network protocol specifications.
20+
- **Interfaces**:
21+
Breaking changes around the client JSON RPC API specifications and standards.
22+
- **Meta SIMDs**:
23+
Describe a process surrounding Solana or propose a change to (or an event in)
24+
a process.
25+
26+
## Before You Begin
27+
28+
Before you write a SIMD, ideas MUST be thoroughly discussed and vetted on the
29+
[ideas section](https://github.com/solana-foundation/solana-improvement-documents/discussions/categories/ideas)
30+
within this
31+
[repo's disucssion page](https://github.com/solana-foundation/solana-improvement-documents/discussions).
32+
Read and review [SIMD-0001](https://github.com/solana-foundation/solana-improvement-documents/blob/main/proposals/0001-simd-process.md),
33+
which describes the SIMD process in detail.
34+
35+
This repository is for documenting standards and not for implementation help.
36+
For specific questions and concerns regarding SIMDs, it's best to discuss them
37+
in the [questions section](https://github.com/solana-foundation/solana-improvement-documents/discussions/categories/questions)
38+
of this [repo's disucssion page](https://github.com/solana-foundation/solana-improvement-documents/discussions).
39+
40+
## Access Policy
41+
42+
The SIMD repository has three levels of access, as detailed in
43+
[SIMD-0007](https://github.com/solana-foundation/solana-improvement-documents/blob/main/proposals/0007-access-policy.md):
44+
45+
1. Triage
46+
2. Write
47+
3. Maintain
48+
49+
To request access or report misuse, please follow the procedures outlined in
50+
SIMD-0007.

proposals/0001-simd-process.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ simd: '0001'
33
title: Solana Proposal Process
44
authors:
55
- Jacob Creech (Solana Foundation)
6+
- Ben Hawkins (Solana Foundation)
67
category: Meta
78
type: Meta
89
status: Living
@@ -83,6 +84,7 @@ The stages in a lifecycle of a proposal are as follows:
8384
- Stagnant
8485
- Withdrawn
8586
- Implemented
87+
- Activated
8688

8789
```mermaid
8890
flowchart LR
@@ -102,7 +104,10 @@ flowchart LR
102104
Idea ---> Draft;
103105
Draft ---> Review;
104106
Review ---> Accepted;
107+
Accepted ---> Implemented;
108+
Implemented ---> Activated;
105109
Review ---> Living;
110+
Accepted ---> Withdrawn;
106111
107112
Draft ---> Stagnant;
108113
Review ---> Stagnant;
@@ -116,9 +121,10 @@ proposal author -- the reviewers, and the Solana Core Contributors.
116121

117122
Before you begin writing a formal proposal, you should vet your idea. Ask the
118123
Solana core community first if an idea is original to avoid wasting time on
119-
something that will be rejected based on prior research. It is thus recommended
120-
to discuss the proposal on the Solana Tech Discord under the #core-technology
121-
channel.
124+
something that will be rejected based on prior research. Be sure to post your
125+
ideas to the
126+
[SIMD ideas discussion page](https://github.com/solana-foundation/solana-improvement-documents/discussions/categories/ideas)
127+
and gather feedback before making your formal Proposal
122128

123129
### Draft
124130

@@ -130,7 +136,8 @@ is descriptive)
130136
- Fill in the proposal. Put care into the details: proposals that do not
131137
present convincing motivation, demonstrate lack of understanding of the
132138
design's impact, or are disingenuous about the drawbacks or alternatives tend
133-
to be poorly received.
139+
to be poorly received. Low quality proposals with limited engagement will be
140+
closed by SIMD repository maintainers.
134141
- Submit a pull request.
135142
- Now that your proposal has an open pull request, use the issue number of the
136143
PR to update the `XXXX-` prefix to the number.
@@ -160,6 +167,16 @@ far the most effective way to see a proposal through to completion: authors
160167
should not expect that other project developers will take on responsibility for
161168
implementing their accepted feature.
162169

170+
### Implemented
171+
172+
When all relevant teams have completed development of the SIMD's feature, the
173+
SIMD is "Implemented".
174+
175+
### Activated
176+
177+
A proposal will have the status Activated once it has been implemented,
178+
tested, and finally activated on mainnet beta.
179+
163180
### Living
164181

165182
A special status for SIMDs that are designed to be continually updated and not

0 commit comments

Comments
 (0)