Skip to content

Commit 4ed656c

Browse files
committed
Add RFC template
Fixes #2
1 parent ea2475f commit 4ed656c

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

0000-template.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
- Start Date: (fill me in with today's date, YYYY-MM-DD)
2+
- RFC PR: (leave this empty)
3+
- Nix Issue: (leave this empty)
4+
5+
# Summary
6+
[summary]: #summary
7+
8+
One para explanation of the feature.
9+
10+
# Motivation
11+
[motivation]: #motivation
12+
13+
Why are we doing this? What use cases does it support? What is the expected
14+
outcome?
15+
16+
# Detailed design
17+
[design]: #detailed-design
18+
19+
This is the bulk of the RFC. Explain the design in enough detail for somebody
20+
familiar with the language and library to understand. This should get into
21+
specifics and corner-cases, and include examples of how the feature is used.
22+
23+
# Drawbacks
24+
[drawbacks]: #drawbacks
25+
26+
Why should we *not* do this?
27+
28+
# Alternatives
29+
[alternatives]: #alternatives
30+
31+
What other designs have been considered? What is the impact of not doing this?
32+
33+
# Unresolved questions
34+
[unresolved]: #unresolved-questions
35+
36+
What parts of the design are still TBD?

0 commit comments

Comments
 (0)