RFC
History /
Edit /
PDF /
EPUB /
BIB /
Created: November 17, 2019 / Updated: November 2, 2024 / Status: draft / 2 min read (~283 words)
Created: November 17, 2019 / Updated: November 2, 2024 / Status: draft / 2 min read (~283 words)
- Keep all RFCs under a single location
- Uniquely identify RFCs
- Use a shared template
- Editor: Name <email>
- Status: Draft/Review/Approved/Abandoned/Implemented
- Required approvers: Name <email> (why), Name <email> (why), ...
- Approvers: Name <email> (date), Name <email> (date), ...
- Created on: <date>
- Updated on: <date>
- Overview: A high level description of what you're describing in the document
- Background/Context: Context relevant to understanding the document
- Problem description: Describe what you are currently cannot do and want to be able to do
- Motivation/Why: Why is it relevant to solve this problem now?
- Drawbacks/Why not: What are the downsides of solving this problem?
- Proposed solution: What is the best solution proposed?
- Alternative solutions: What are the alternative solutions considered and why aren't they the proposed solution?
- Impact and risks: What will be the impact of this change on existing systems, processes, or stakeholders?
- Unresolved questions: What are the questions that need to be answered but don't have an answer to yet?
- References: Documents/URLs that can be useful to consult
- If a RFC is abandoned, the reasons why should be made explicit in the document
- https://en.wikipedia.org/wiki/Request_for_Comments
- https://github.com/rust-lang/rfcs/blob/master/0000-template.md
- https://wiki.en.it-processmaps.com/index.php/Checklist_Request_for_Change_RFC
- Sourcegraph RFC template: https://docs.google.com/document/d/1TRVmwpLzTgYWhBqPwkSWpzPYvXI3Z2miJSmBN2G7ygc/edit
- https://about.sourcegraph.com/handbook/engineering/rfcs
- https://blog.pragmaticengineer.com/scaling-engineering-teams-via-writing-things-down-rfcs/
- https://github.com/golang/proposal/blob/master/design/TEMPLATE.md