forked from solana-foundation/solana-improvement-documents
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update SIMD-0001 (solana-foundation#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 <[email protected]> Co-authored-by: Trent Nelson <[email protected]> * make linter happy :) --------- Co-authored-by: Jacob Creech <[email protected]> Co-authored-by: Trent Nelson <[email protected]>
- Loading branch information
1 parent
0f2e1e9
commit 9359c71
Showing
3 changed files
with
73 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,50 @@ | ||
# Solana Improvement Documents | ||
Solana IMprovement Documents (SIMD) describe proposed and accepted changes to the Solana protocol. | ||
# Solana Improvement Documents (SIMDs) | ||
|
||
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. | ||
|
||
## SIMD Types | ||
|
||
SIMDs can be divided into the following categories: | ||
|
||
- **Standard SIMDs**: | ||
Describe changes that affect most or all Solana implementations, such as: | ||
- **Core**: | ||
Changes affecting consensus or substantial changes to the validator. | ||
- **Networking**: | ||
Changes or substantial improvements to network protocol specifications. | ||
- **Interfaces**: | ||
Breaking changes around the client JSON RPC API specifications and standards. | ||
- **Meta SIMDs**: | ||
Describe a process surrounding Solana or propose a change to (or an event in) | ||
a process. | ||
|
||
## Before You Begin | ||
|
||
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. | ||
|
||
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). | ||
|
||
## Access Policy | ||
|
||
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): | ||
|
||
1. Triage | ||
2. Write | ||
3. Maintain | ||
|
||
To request access or report misuse, please follow the procedures outlined in | ||
SIMD-0007. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters