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.
 
 
 
 
 
 
Joon 2d726a620b add adr (#2553) 6 years ago
..
img added initial trust metric design doc and code 7 years ago
README.md adr: update readme 6 years ago
adr-001-logging.md docs: update and clean up adr 7 years ago
adr-002-event-subscription.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-003-abci-app-rpc.md docs: update and clean up adr 7 years ago
adr-004-historical-validators.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-005-consensus-params.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-006-trust-metric.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-007-trust-metric-usage.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-008-priv-validator.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-009-ABCI-design.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-010-crypto-changes.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-011-monitoring.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-012-peer-transport.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-013-symmetric-crypto.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-014-secp-malleability.md crypto/secp256k1: Fix signature malleability, adopt more efficient en… (#2239) 6 years ago
adr-015-crypto-encoding.md crypto/secp256k1: Fix signature malleability, adopt more efficient en… (#2239) 6 years ago
adr-016-protocol-versions.md update adr-016 (#2435) 6 years ago
adr-017-chain-versions.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-018-ABCI-Validators.md update ADR 6 years ago
adr-019-multisigs.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-020-block-size.md update arch doc 6 years ago
adr-021-abci-events.md adr-021: note about tag spacers (#2362) 6 years ago
adr-022-abci-errors.md [ADR] ABCI errors and events (#2314) 6 years ago
adr-023-ABCI-propose-tx.md [ADR] ABCI errors and events (#2314) 6 years ago
adr-024-sign-bytes.md [ADR][DRAFT] 024: SignBytes and validator types in privval (#2445) 6 years ago
adr-025-commit.md Add ADR for Commit changes (#2374) 6 years ago
adr-026-general-merkle-proof.md add adr (#2553) 6 years ago
adr-029-check-tx-consensus.md adr-029: update CheckBlock 6 years ago
adr-030-consensus-refactor.md consensus: Add ADR for first stage consensus refactor (#2462) 6 years ago
adr-template.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago

README.md

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.