Skip to content

ADR NNNN — <Decision title> ​

  • Status: Proposed | Accepted (ratified by <owner>, <date>) | Superseded by NNNN
  • Date: <date>
  • Roadmap: which items this gates / is gated by
  • Deciders: <owner>

1. Context ​

What the system does today (concrete file paths), what is changing, and the exact question this ADR settles: "The question this ADR settles: …"

2. Decision drivers ​

Numbered, concrete, ranked.

3. Options considered ​

For each: one-line mechanism, then + and − bullets. Always include "do the simplest thing" and say honestly where it stops scaling.

4. Decision ​

Name the option. The concrete rules, numbered, each enforceable. End with a one-line rule for the team — if it cannot be compressed to one line, it is not crisp enough yet.

5. The convention this creates ​

The file/package layout or contract other work implements against (an actual tree or shape).

6. Migration from today ​

Today → After per moving part; say what does NOT change.

7. Consequences ​

Positive / costs accepted (with mitigations) / neutral follow-ups.

8. What this unblocks ​


Source: docs/adr/TEMPLATE.md — edit it there; the site mirrors the repository.

Apache-2.0. The docs are mirrored from the repository on every merge.