Skip to content

Instantly share code, notes, and snippets.

@michaelcurry

michaelcurry/rfc-template.md

Created September 29, 2016 18:07
Show Gist options
  • Star 35 You must be signed in to star a gist
  • Fork 13 You must be signed in to fork a gist
  • Save michaelcurry/e0132058fcd6d588a1299afd69638df4 to your computer and use it in GitHub Desktop.
Save michaelcurry/e0132058fcd6d588a1299afd69638df4 to your computer and use it in GitHub Desktop.
Download ZIP
RFC Template [Markdown]
Raw
rfc-template.md

RFC Template

Feature Name: (fill me in with a unique identity, myawesomefeature)

Type: (feature, enhancement)

Start Date: (fill me in with today's date, YYYY-MM-DD)

Author: (your names)

Related components: (if any)

JIRA issues: (list of SL- numbers)

Summary

One paragraph explanation of the feature.

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 for somebody familiar with the network to understand, and for somebody familiar with the code practices to implement. This should get into specifics and corner-cases, and include examples of how the feature is used.

Drawbacks

I Why should we not do this?

Alternatives

What other designs have been considered? What is the impact of not doing this?

Unresolved questions

What parts of the design are still to be done?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment