Skip to content

Commit 2ba03c0

Browse files
committed
update linting; add README.md update; update mermaid plot on SIMD-0001
1 parent 46c8654 commit 2ba03c0

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

.github/linter/customRules.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,7 @@ export const metadataStatusIsValid = {
287287
"Stagnant",
288288
"Withdrawn",
289289
"Implemented",
290+
"Activated",
290291
]
291292

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

README.md

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

proposals/0001-simd-process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ flowchart LR
104104
Idea ---> Draft;
105105
Draft ---> Review;
106106
Review ---> Accepted;
107+
Accepted ---> Implemented
107108
Review ---> Living;
108109
109110
Draft ---> Stagnant;

0 commit comments

Comments
 (0)