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.

35 lines
1.2 KiB

  1. # RFC {RFC-NUMBER}: {TITLE}
  2. ## Changelog
  3. - {date}: {changelog}
  4. ## Abstract
  5. > A brief high-level synopsis of the topic of discussion for this RFC, ideally
  6. > just a few sentences. This should help the reader quickly decide whether the
  7. > rest of the discussion is relevant to their interest.
  8. ## Background
  9. > Any context or orientation needed for a reader to understand and participate
  10. > in the substance of the Discussion. If necessary, this section may include
  11. > links to other documentation or sources rather than restating existing
  12. > material, but should provide enough detail that the reader can tell what they
  13. > need to read to be up-to-date.
  14. ### References
  15. > Links to external materials needed to follow the discussion may be added here.
  16. >
  17. > In addition, if the discussion in a request for comments leads to any design
  18. > decisions, it may be helpful to add links to the ADR documents here after the
  19. > discussion has settled.
  20. ## Discussion
  21. > This section contains the core of the discussion.
  22. >
  23. > There is no fixed format for this section, but ideally changes to this
  24. > section should be updated before merging to reflect any discussion that took
  25. > place on the PR that made those changes.