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.

42 lines
1.5 KiB

  1. ---
  2. order: 1
  3. parent:
  4. order: false
  5. ---
  6. # Requests for Comments
  7. A Request for Comments (RFC) is a record of discussion on an open-ended topic
  8. related to the design and implementation of Tendermint Core, for which no
  9. immediate decision is required.
  10. The purpose of an RFC is to serve as a historical record of a high-level
  11. discussion that might otherwise only be recorded in an ad hoc way (for example,
  12. via gists or Google docs) that are difficult to discover for someone after the
  13. fact. An RFC _may_ give rise to more specific architectural _decisions_ for
  14. Tendermint, but those decisions must be recorded separately in [Architecture
  15. Decision Records (ADR)](./../architecture).
  16. As a rule of thumb, if you can articulate a specific question that needs to be
  17. answered, write an ADR. If you need to explore the topic and get input from
  18. others to know what questions need to be answered, an RFC may be appropriate.
  19. ## RFC Content
  20. An RFC should provide:
  21. - A **changelog**, documenting when and how the RFC has changed.
  22. - An **abstract**, briefly summarizing the topic so the reader can quickly tell
  23. whether it is relevant to their interest.
  24. - Any **background** a reader will need to understand and participate in the
  25. substance of the discussion (links to other documents are fine here).
  26. - The **discussion**, the primary content of the document.
  27. The [rfc-template.md](./rfc-template.md) file includes placeholders for these
  28. sections.
  29. ## Table of Contents
  30. - [RFC-000: P2P Roadmap](./rfc-000-p2p-roadmap.rst)
  31. <!-- - [RFC-NNN: Title](./rfc-NNN-title.md) -->