Skip to content

Instantly share code, notes, and snippets.

@tucq88
Created November 11, 2023 10:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tucq88/a5ee515a9fcaf918cffe26f60f25e7b0 to your computer and use it in GitHub Desktop.
Save tucq88/a5ee515a9fcaf918cffe26f60f25e7b0 to your computer and use it in GitHub Desktop.
A sample template for RFC

RFC Template

Feature Name: [unique identity, e.g myawesomefeature]

Type: [Select of feature, improvement, breaking-change]

Start Date: [Today, recommend YYYY-MM-DD format]

Author: [ Names [email] ]

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

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