Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ADR-NNNN: Title

  • Status: Proposed
  • Date: YYYY-MM-DD
  • Supersedes / Superseded by: —

Context

What problem are we solving? What forces are in play (constraints, goals, prior art)? Written so a newcomer two years from now understands the situation without the PR thread.

Decision

The decision, stated in one or two sentences, in the active voice. Then any detail needed to apply it consistently.

Consequences

What becomes easier, what becomes harder, what we are now committed to. Include the costs honestly — an ADR with no downsides wasn’t thought through.

Alternatives considered

Each rejected option with the one real reason it lost.