mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2025-12-23 06:15:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
wb/update-mockery
tendermint/docs/rfc/README.md
Mark Rushakoff b6a515a818 docs/rfc: add testnet RFC (#9124) 
* docs/rfc: add testnet RFC

Following several discussions internal to the Tendermint engineering
team, I am posting an RFC discussing the high-level details of the
Tendermint team owning and operating a long-lived testnet in order to
build experience running Tendermint, and to demonstrate that Tendermint
is stable under production workloads.

The outcome of this RFC will be a new track of work to begin building
and maintaining a testnet associated with the main branch of tendermint.
See the "Testnet MVP" section specifically for some of the first
milestones.

Note, I added the RFC where it would live once #9115 is merged to
restore the RFC layout from the v0.36.x branch. docs/rfc/README.md will
need to be updated to include this RFC once #9115 is merged.

This RFC is related to #9078.

* docs/rfc: minor updates to testnet rfc

* docs/rfc: respond to more feedback on testnet RFC

* docs/rfc: add RFC 023 to rfc index
2022-08-01 11:33:04 -04:00

3.0 KiB
Raw Permalink Blame History

order, parent
order parent
1
order
false

Requests for Comments

A Request for Comments (RFC) is a record of discussion on an open-ended topic related to the design and implementation of Tendermint Core, for which no immediate decision is required.

The purpose of an RFC is to serve as a historical record of a high-level discussion that might otherwise only be recorded in an ad hoc way (for example, via gists or Google docs) that are difficult to discover for someone after the fact. An RFC may give rise to more specific architectural decisions for Tendermint, but those decisions must be recorded separately in Architecture Decision Records (ADR).

As a rule of thumb, if you can articulate a specific question that needs to be answered, write an ADR. If you need to explore the topic and get input from others to know what questions need to be answered, an RFC may be appropriate.

RFC Content

An RFC should provide:

  • A changelog, documenting when and how the RFC has changed.
  • An abstract, briefly summarizing the topic so the reader can quickly tell whether it is relevant to their interest.
  • Any background a reader will need to understand and participate in the substance of the discussion (links to other documents are fine here).
  • The discussion, the primary content of the document.

The rfc-template.md file includes placeholders for these sections.

Table of Contents