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.
 
 
 
 
 
 
Ethan Buchman 1215081951 adr: update readme 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 docs: update and clean up adr 7 years ago
adr-003-abci-app-rpc.md docs: update and clean up adr 7 years ago
adr-004-historical-validators.md docs: update and clean up adr 7 years ago
adr-005-consensus-params.md Updates -> ValidatoSetUpdates 7 years ago
adr-006-trust-metric.md added changes based on PR comments to the proposal 7 years ago
adr-007-trust-metric-usage.md adr: update 007 trust metric usage 7 years ago
adr-008-priv-validator.md Make types use Amino; Refactor PrivValidator* to FilePV/SocketPV 7 years ago
adr-009-ABCI-design.md adr: update readme 6 years ago
adr-010-crypto-changes.md fixes from review 6 years ago
adr-011-monitoring.md update ADR 6 years ago
adr-template.md docs: update and clean up adr 7 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.