Skip to content

Commit 3ea6ea3

Browse files
committed
Update README.md to conform to linting rules
1 parent 2ba03c0 commit 3ea6ea3

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,51 @@
11
# Solana Improvement Documents (SIMDs)
22

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.
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.
49

510
## SIMD Types
611

712
SIMDs can be divided into the following categories:
813

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+
- **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.
1425

1526
## Before You Begin
1627

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.
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.
1834

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).
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).
2039

2140
## Access Policy
2241

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):
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):
2444

2545
1. Triage
2646
2. Write
2747
3. Maintain
2848

29-
To request access or report misuse, please follow the procedures outlined in SIMD-0007.
49+
To request access or report misuse, please follow the procedures outlined in
50+
SIMD-0007.
3051

0 commit comments

Comments
 (0)