diff options
author | zimbatm <zimbatm@zimbatm.com> | 2017-03-18 21:47:24 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-03-18 21:47:24 +0000 |
commit | cff592277607e021975eda348991b618d33d66ea (patch) | |
tree | 1294bcaf9201ab72d0d25df64924d07b8b06d8e3 /0000-template.md | |
parent | 8f83af7ce0f3342bb9d8de21f15dafbaaa1ab4f4 (diff) |
Implement RFC 0001 (#2)
Implement RFC 0001
Diffstat (limited to '0000-template.md')
-rw-r--r-- | 0000-template.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/0000-template.md b/0000-template.md new file mode 100644 index 0000000..c2c87b7 --- /dev/null +++ b/0000-template.md @@ -0,0 +1,41 @@ +--- +feature: (fill me in with a unique ident, my_awesome_feature) +start-date: (fill me in with today's date, YYYY-MM-DD) +author: (name of the main author) +co-authors: (find a buddy later to help our with the RFC) +related-issues: (will contain links to implementation PRs) +--- + +# Summary +[summary]: #summary + +One paragraph explanation of the feature. + +# Motivation +[motivation]: #motivation + +Why are we doing this? What use cases does it support? What is the expected +outcome? + +# Detailed design +[design]: #detailed-design + +This is the bulk of the RFC. Explain the design in enough detail for somebody +familiar with the ecosystem to understand, and implement. This should get +into specifics and corner-cases, and include examples of how the feature is +used. + +# Drawbacks +[drawbacks]: #drawbacks + +Why should we *not* do this? + +# Alternatives +[alternatives]: #alternatives + +What other designs have been considered? What is the impact of not doing this? + +# Unresolved questions +[unresolved]: #unresolved-questions + +What parts of the design are still TBD or unknowns? |