mirror of
https://github.com/tendermint/tendermint.git
synced 2026-02-03 10:32:05 +00:00
ce3c059a0d
This ADR restores a variation of the old Request for Comments documentation that we previously used. The proposal differs from the original formulation, and does not replace ADRs.
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# RFC {RFC-NUMBER}: {TITLE}
|
|
|
|
## Changelog
|
|
|
|
- {date}: {changelog}
|
|
|
|
## Abstract
|
|
|
|
> A brief high-level synopsis of the topic of discussion for this RFC, ideally
|
|
> just a few sentences. This should help the reader quickly decide whether the
|
|
> rest of the discussion is relevant to their interest.
|
|
|
|
## Background
|
|
|
|
> Any context or orientation needed for a reader to understand and participate
|
|
> in the substance of the Discussion. If necessary, this section may include
|
|
> links to other documentation or sources rather than restating existing
|
|
> material, but should provide enough detail that the reader can tell what they
|
|
> need to read to be up-to-date.
|
|
|
|
### References
|
|
|
|
> Links to external materials needed to follow the discussion may be added here.
|
|
>
|
|
> In addition, if the discussion in a request for comments leads to any design
|
|
> decisions, it may be helpful to add links to the ADR documents here after the
|
|
> discussion has settled.
|
|
|
|
## Discussion
|
|
|
|
> This section contains the core of the discussion.
|
|
>
|
|
> There is no fixed format for this section, but ideally changes to this
|
|
> section should be updated before merging to reflect any discussion that took
|
|
> place on the PR that made those changes.
|