Skip to content

Commit 3bc8e44

Browse files
authored
docs(rfc): adopt per-RFC folder structure (#870)
Each RFC now lives in its own folder (rfc/NNNN-short-name/) with README.md as the main proposal. This gives each RFC room for diagrams, images, and other supporting files without cluttering the top level. Move 0000-template into the new layout and update rfc/README.md to describe the convention.
1 parent 5718553 commit 3bc8e44

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

File renamed without changes.

rfc/README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,25 @@ An RFC can be in one of the following states:
8787

8888
### 1. Reserve an RFC number
8989

90-
Look at the existing RFCs in this directory and choose the next available number. If two authors happen to pick the same number on separate branches, the conflict is resolved during PR review — the later PR simply picks the next available number.
90+
Look at the existing RFC folders in this directory and choose the next available number. If two authors happen to pick the same number on separate branches, the conflict is resolved during PR review — the later PR simply picks the next available number.
9191

9292
### 2. Create your RFC
9393

94-
Copy `0000-template.md` to `NNNN-my-feature.md` where `NNNN` is your RFC number (zero-padded to 4 digits) and `my-feature` is a short descriptive name.
94+
Each RFC lives in its own folder:
95+
96+
```
97+
rfc/NNNN-my-feature/
98+
README.md
99+
(optional: diagrams, images, supporting files)
100+
```
101+
102+
Where `NNNN` is your RFC number (zero-padded to 4 digits) and `my-feature` is a short descriptive name. The main proposal goes in `README.md` so GitHub renders it when browsing the folder.
103+
104+
To start a new RFC, copy the template folder:
105+
106+
```shell
107+
cp -r rfc/0000-template rfc/NNNN-my-feature
108+
```
95109

96110
Fill in the metadata and start writing. The state should be `draft` while you're iterating.
97111

@@ -129,7 +143,7 @@ graph LR
129143
```
130144
````
131145

132-
Prefer Mermaid over external image files whenever possible. If a diagram is too complex for Mermaid (e.g., detailed UI mockups), commit the image to the same directory as the RFC and reference it with a relative path.
146+
Prefer Mermaid over external image files whenever possible. If a diagram is too complex for Mermaid (e.g., detailed UI mockups), commit the image to the RFC's folder alongside its `README.md` and reference it with a relative path.
133147

134148
## Making changes to an RFC
135149

0 commit comments

Comments
 (0)