Skip to content

Commit

Permalink
Adds rfc template (#316)
Browse files Browse the repository at this point in the history
  • Loading branch information
delambo authored and ccpricenytimes committed Nov 3, 2016
1 parent 9a625f1 commit 92f95a8
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
30 changes: 30 additions & 0 deletions rfc/template.md
Original file line number Diff line number Diff line change
@@ -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?

0 comments on commit 92f95a8

Please sign in to comment.