| description |
|---|
Template page for RFCs. Duplicate it to start a new RFC. |
{% hint style="info" %} Duplicate this page to start a new RFC. Do not merge the change request before the RFC got approved.
Read the process for more details. {% endhint %}
| Author | Start date | Implementation issue |
|---|---|---|
One paragraph explanation of the feature.
Why are we doing this? What use cases does it support? What is the expected outcome?
Please focus on explaining the motivation so that if this RFC is not accepted, the motivation could be used to develop alternative solutions. In other words, enumerate the constraints you are trying to solve without coupling them too closely to the solution you have in mind.
This is the bulk of the RFC. Explain the design in enough detail for somebody familiar with the project to understand, and for somebody familiar with the implementation to implement. This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
Why should we not do this? Please consider:
- implementation cost, both in term of size and complexity
- whether the proposed feature can be implemented in user space
- integration of this feature with other existing and planned features
- cost of migrating (is it a breaking change?)
There are tradeoffs to choosing any path. Attempt to identify them here.
What other designs have been considered? What is the impact of not doing this?
- What parts of the design do you expect to resolve through the RFC process before this gets merged?
- What parts of the design do you expect to resolve through the implementation of this feature before stabilization?
- What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?
Think about what the natural extension and evolution of your proposal would be and how it would affect the project as a whole in a holistic way. Try to use this section as a tool to more fully consider all possible interactions with the project in your proposal. Also consider how this all fits into the roadmap for the project and of the relevant team.
This is also a good place to "dump ideas", if they are out of scope for the RFC you are writing but otherwise related.
If you have tried and cannot think of any future possibilities, you may simply state that you cannot think of anything.
Note that having something written down in the future-possibilities section is not a reason to accept the current or a future RFC; such notes should be in the section on motivation or rationale in this or subsequent RFCs. The section merely provides additional information.
{% hint style="success" %} Finishing drafting the RFC? Do not merge the change request, but submit it for review. {% endhint %}