Skip to content

Instantly share code, notes, and snippets.

@ans-4175
Forked from michaelcurry/rfc-template.md
Last active December 1, 2022 17:05
Show Gist options
  • Save ans-4175/f90b17c270f4ec1841fd98e251660eae to your computer and use it in GitHub Desktop.
Save ans-4175/f90b17c270f4ec1841fd98e251660eae to your computer and use it in GitHub Desktop.
RFC Template [Markdown]

RFC Template

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

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

Author: (your names)

Related components/issues: (if any)

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 core of the RFC. Explain the design in enough detail for somebody to understand the problem, 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. You can use wireframe, activity flow, system design, pseudo code, anything diagrams you need to. But please make it concise.

Drawbacks

List of why should we not do this? Any trade offs?

Alternatives

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

Milestones

What are steps or checkpoints need to make to achieve this design idea

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