Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 2.94 KB

.template.md

File metadata and controls

90 lines (58 loc) · 2.94 KB

<short_summary_of_proposal>

IMPORTANT: Fill in and remove all italicized text before submission. If a section is not applicable, remove it.

Status Proposed, Accepted, Implemented, Obsolete
RFC # Update after PR has been made
Author(s) (@<my-github>), (@another-github)
SIG / WG Applicable SIG(s) or Working Group(s)
Obsoletes <RFC-#s>, if any, or remove header

Overview

If someone only reads this far, what do you want them to know?

Goals and Non-Goals

What problems are you trying to solve? What problems are not not trying to solve?

Motivation and Rationale

What is the current state of the world? Why is this change being proposed? What are the benefits for users (end-users, engineers, operators, etc.)? Who have you identified as early customers of this change?

Timeline

What is the proposed timeline for the implementation? This timeline should encompass the entire scope of the project, not just the initial merge of the code. If applicable, it should include when the feature will be ready for testing by potential customers, when you will address their feedback, and when the code will be considered production-ready.

Design

What exactly are you doing? What is this change being proposed?

This is typically the longest part of the RFC.

Dependencies

What existing internal and external systems does this proposal depend on? Are any new dependencies (libraries or systems) being introduced?

Drawbacks

Why should we not do this?

Prior Art and Alternatives

What other approaches did you consider? What existing solutions are close but not quite right? How will this project replace or integrate with the alternatives?

Known Unknowns

What parts of the design do you expect to resolve through the RFC process? What parts of the design do you expect to resolve through implementation before stabilization? What related issues do you consider out of scope for this RFC that could be addressed in the future?

Security, Privacy, and Compliance

What security/privacy/compliance aspects should be considered?

If you are not certain, never assume there aren't any. Always talk to the Security SIG or Technical Oversight Committee.

Operations

Are you adding any new, regular human processes, or extra work for any users? What telemetry is needed to verify correct behavior? What tooling needs to be introduced for on-going support?

Risks

What known risks exist? What factors may complicate your project?

Include: security, complexity, compatibility, latency, service immaturity, lack of team expertise, etc.

Future Possibilities

What are the natural extensions and evolution of this RFC that would affect the project as a whole?

Feel free to dump ideas here, they're meant to get wheels turning, and won't affect the outcome of the approval process.