Last active
August 5, 2021 05:21
-
-
Save steerpike/dff4cd8103a1e5024c0b94a4f4f6e234 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Creation Date: (fill me in with today's date, YYYY-MM-DD) | |
# Summary | |
Brief explanation of the proposal. | |
# Motivation | |
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. | |
# Detailed design | |
This is the bulk of the RFC. Explain the design in enough detail for somebody | |
familiar with the system 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 proposal is used. Any new terminology should be | |
defined here. | |
# Drawbacks | |
Why should we *not* do this? Please consider: | |
- implementation cost, both in term of code size and complexity | |
- the long term viability of the solution | |
- integration of this feature with other existing and planned features | |
There are tradeoffs to choosing any path. Attempt to identify them here. | |
# Alternatives | |
What other designs have been considered? What is the impact of not doing this? | |
# Adoption strategy | |
If we implement this proposal, how will existing developers adopt it? Is | |
this a breaking change? Should we coordinate with other projects or teams? | |
# How we teach this | |
What names and terminology work best for these concepts and why? How is this | |
idea best presented? How does a developer adopt this change into the | |
application and workflow. | |
Would the acceptance of this proposal mean that documentation must be | |
re-organized or altered? Does it require tutorials, how-to guides, | |
technical references or explanation? | |
# Unresolved questions | |
Optional, but suggested for first drafts. What parts of the design are still | |
TBD? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment