Skip to content

Commit 2d42ce8

Browse files
committed
chore: create template for RFC
1 parent 4190424 commit 2d42ce8

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/rfc/0000-template.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# {{TITLE: a human-readable title for this RFC!}}
2+
3+
## Summary
4+
5+
{{A concise, one-paragraph description of the change.}}
6+
7+
## Motivation
8+
9+
{{Why are we doing this? What pain points does this resolve? What use cases does it support? What is the expected outcome? Use real, concrete examples to make your case!}}
10+
11+
## Detailed Explanation
12+
13+
{{Describe the expected changes in detail, }}
14+
15+
## Rationale and Alternatives
16+
17+
{{Discuss 2-3 different alternative solutions that were considered. This is required, even if it seems like a stretch. Then explain why this is the best choice out of available ones.}}
18+
19+
## Implementation
20+
21+
{{Give a high-level overview of implementation requirements and concerns. Be specific about areas of code that need to change, and what their potential effects are. Discuss which repositories and sub-components will be affected, and what its overall code effect might be.}}
22+
23+
{{THIS SECTION IS REQUIRED FOR RATIFICATION -- you can skip it if you don't know the technical details when first submitting the proposal, but it must be there before it's accepted}}
24+
25+
## Prior Art
26+
27+
{{This section is optional if there are no actual prior examples in other tools}}
28+
29+
{{Discuss existing examples of this change in other tools, and how they've addressed various concerns discussed above, and what the effect of those decisions has been}}
30+
31+
## Unresolved Questions and Bikeshedding
32+
33+
{{Write about any arbitrary decisions that need to be made (syntax, colors, formatting, minor UX decisions), and any questions for the proposal that have not been answered.}}
34+
35+
{{THIS SECTION SHOULD BE REMOVED BEFORE RATIFICATION}}

0 commit comments

Comments
 (0)