From 92f95a84121da84539dc5dedc7603450561cf7dd Mon Sep 17 00:00:00 2001 From: Matthew DeLambo Date: Thu, 3 Nov 2016 14:56:17 -0400 Subject: [PATCH] Adds rfc template (#316) --- CONTRIBUTING.md | 4 ++++ rfc/template.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 rfc/template.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9da441d0a..e34de3fba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,10 @@ We recommend forking kyt and creating a test project with a starter-kyt for loca ### Testing kyt Instructions TK +## Create an RFC + +If you want to propose a large feature idea or architecture change you should consider submitting an RFC. It's often helpful to get feedback on your concept in an issue before starting the RFC. RFCs are an evolving process in the kyt repository so expect a lot of changes and guidelines in the future. You can find the kyt RFC template [here](/rfc/template.md). + ## Build a starter-kyt Have a great idea for a boilerplate? Build it on top of kyt and let us know about it. Directions are [here](/docs/Starterkyts.md). diff --git a/rfc/template.md b/rfc/template.md new file mode 100644 index 000000000..39f3cc35c --- /dev/null +++ b/rfc/template.md @@ -0,0 +1,30 @@ + +## Summary +[summary]: #summary + +One paragraph explanation of the feature. + +## Motivation +[motivation]: #motivation + +This is the most important section in the RFC. Why are we doing this? What use cases does it support? What is the expected outcome? + +## Detailed design +[design]: #detailed-design + +Explain the design in enough detail for somebody familiar with kyt to understand, and for somebody familiar with the implementation to implement. This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here. + +## 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?