rfc tmpl (sofastack#699)

lofish369 · Oct 21, 2021 · 280decf · 280decf
1 parent c72a9b6
commit 280decf
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 0 deletions.
diff --git a/rfcs/0001-new-log-storage.md b/rfcs/0001-new-log-storage.md
@@ -0,0 +1,35 @@
+- Feature Name: XXXX
+- Date: YYYY-MM-DD
+- RFC PR: #
+
+## Summary
+
+One para explanation of the proposal.
+
+## Motivation
+
+Why are we doing this? What use cases does it support? What is the expected
+outcome?
+
+## Detailed Design
+
+This is the bulk of the RFC. Explain the design in enough detail that:
+
+- It is reasonably clear how the feature would be implemented.
+- Corner cases dissected by example.
+- How is the feature used.
+
+## Drawbacks
+
+Why should we not do this?
+
+## Alternative
+
+- Why is this design the best in the space of possible designs?
+- What other designs have been considered and what is the rationale for not
+  choosing them?
+- What is the impact of not doing this?
+
+## Unresolved questions
+
+What parts of the design are still to be determined?
diff --git a/rfcs/tmpl.md b/rfcs/tmpl.md
@@ -0,0 +1,35 @@
+- Feature Name: XXXX
+- Date: YYYY-MM-DD
+- RFC PR: #
+
+## Summary
+
+One para explanation of the proposal.
+
+## Motivation
+
+Why are we doing this? What use cases does it support? What is the expected
+outcome?
+
+## Detailed Design
+
+This is the bulk of the RFC. Explain the design in enough detail that:
+
+- It is reasonably clear how the feature would be implemented.
+- Corner cases dissected by example.
+- How is the feature used.
+
+## Drawbacks
+
+Why should we not do this?
+
+## Alternative
+
+- Why is this design the best in the space of possible designs?
+- What other designs have been considered and what is the rationale for not
+  choosing them?
+- What is the impact of not doing this?
+
+## Unresolved questions
+
+What parts of the design are still to be determined?