mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 06:42:16 +00:00
9e4cd19878
* ADR TOC in readme.md * Added A TOC to the Readme.md of ADR Section - Added table of contents to the Readme of the architecture section. - Easier to traverse and when you know what is there. - If the Adr's become viewable online it would help guide the user Signed-off-by: Marko Baricevic <marbar3778@yahoo.com> * add tm-cmn to subprojects * normalize word
Architecture Decision Records (ADR)
This is a location to record all high-level architecture decisions in the tendermint project.
You can read more about the ADR concept in this blog post.
An ADR should provide:
- Context on the relevant goals and the current state
- Proposed changes to achieve the goals
- Summary of pros and cons
- References
- Changelog
Note the distinction between an ADR and a spec. The ADR provides the context, intuition, reasoning, and justification for a change in architecture, or for the architecture of something new. The spec is much more compressed and streamlined summary of everything as it stands today.
If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.
Note the context/background should be written in the present tense.
Table of Contents:
- ADR-001-Logging
- ADR-002-Event-Subscription
- ADR-003-ABCI-APP-RPC
- ADR-004-Historical-Validators
- ADR-005-Consensus-Params
- ADR-006-Trust-Metric
- ADR-007-Trust-Metric-Usage
- ADR-008-Priv-Validator
- ADR-009-ABCI-Design
- ADR-010-Crypto-Changes
- ADR-011-Monitoring
- ADR-012-Peer-Transport
- ADR-013-Symmetric-Crypto
- ADR-014-Secp-Malleability
- ADR-015-Crypto-Encoding
- ADR-016-Protocol-Versions
- ADR-017-Chain-Versions
- ADR-018-ABCI-Validators
- ADR-019-Multisigs
- ADR-020-Block-Size
- ADR-021-ABCI-Events
- ADR-022-ABCI-Errors
- ADR-023-ABCI-Propose-tx
- ADR-024-Sign-Bytes
- ADR-025-Commit
- ADR-026-General-Merkle-Proof
- ADR-029-Check-Tx-Consensus
- ADR-030-Consensus-Refactor
- ADR-033-Pubsub
- ADR-034-Priv-Validator-File-Structure
- ADR-035-Documentation
- ADR-037-Deliver-Block
- ADR-039-Peer-Behaviour
- ADR-041-Proposer-Selection-via-ABCI
- ADR-043-Blockchain-RiRi-Org