You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

39 lines
1.3 KiB

  1. # RFC {RFC-NUMBER}: {TITLE}
  2. ## Changelog
  3. - {date}: {changelog}
  4. ## Author(s)
  5. - {First Name} {github handle}
  6. ## Context
  7. > This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution.
  8. ## Proposal
  9. > It should contain a detailed breakdown of how the problem should be resolved including diagrams and other supporting materials needed to present the case and implementation roadmap for the proposed changes. The reader should be able to fully understand the proposal. This section should be broken up using ## subsections as needed.
  10. ## Status
  11. > A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later RFC changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.
  12. {Deprecated|Proposed|Accepted}
  13. ## Consequences
  14. > This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones.
  15. ### Positive
  16. ### Negative
  17. ### Neutral
  18. ## References
  19. > Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!
  20. - {reference link}