Skip to content

Instantly share code, notes, and snippets.

@pdxmph
Last active April 19, 2022 04:15
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 pdxmph/cb47bd5acb68f7fb8080f56a83c497a2 to your computer and use it in GitHub Desktop.
Save pdxmph/cb47bd5acb68f7fb8080f56a83c497a2 to your computer and use it in GitHub Desktop.
Simple Markdown RFC template

RFC: TEMPLATE

Summary:

**Created: **

**Deadline/Timeframe: **

DACI

**Driver: **

**Approver: **

**Contributor: **

**Informed: **


Overview

%%The RFC begins with a brief overview. This section should be one or two paragraphs that just explains what the goal of this RFC is going to be, but without diving too deeply into the "why", "why now", "how", etc. Ensure anyone opening the document will form a clear understanding of the RFCs intent from reading this paragraph(s).

Background

%%The next section is the "Background" section. This section should be at least two paragraphs and can take up to a whole page in some cases. The guiding goal of the background section is: as a newcomer to this project (new employee, team transfer), can I read the background section and follow any links to get the full context of why this change is necessary? 

%% If you can't show a peer the background section and have them acquire nearly full context on the necessity for the RFC, then the background section is not full enough. To help achieve this, link to prior RFCs, discussions, and more here as necessary to provide context so you don't have to simply repeat yourself.

Proposal

%% The next required section is "Proposal" or "Goal". Given the background above, this section proposes a solution. This should be an overview of the "how" for the solution, but for details further sections will be used.

Abandoned Ideas (Optional)

%% As RFCs evolve, it is common that there are ideas that are abandoned. Rather than simply deleting them from the document, you should try to organize them into sections that make it clear they're abandoned while explaining why they were abandoned.

%% When sharing your RFC with others or having someone look back on your RFC in the future, it is common to walk the same path and fall into the same pitfalls that we've since matured from. Abandoned ideas are a way to recognize that path and explain the pitfalls and why they were abandoned.

Outcomes

%% Make sure to record the final outcomes, next steps, links to tickets that resulted from the RFC, etc. Some teams like to post the finalized RFC, once all comments are clear, on a wiki or in a shared folder.

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