38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
 
|
---
|
||
|
|
type: adr
|
||
|
|
id: "0000"
|
||
|
|
status: proposed # proposed | accepted | superseded
|
||
|
|
date: YYYY-MM-DD
|
||
|
|
supersedes: null # path to older ADR, e.g. docs/adr/0002-old.md
|
||
|
|
superseded_by: null # filled in on the OLD adr when a new one replaces it
|
||
|
|
related: [] # optional: paths to design docs / issues
|
||
|
|
---
|
||
|
|
|
||
|
|
<!-- Copy to docs/adr/NNNN-slug.md. Delete all comments when filling in. -->
|
||
|
|
|
||
|
|
# ADR-0000: Title
|
||
|
|
|
||
|
|
## Context
|
||
|
|
|
||
|
|
<!-- The situation and the forces at play. Constraints upfront:
|
||
|
|
deadlines, scale, team knowledge, existing decisions. -->
|
||
|
|
|
||
|
|
## Options Considered
|
||
|
|
|
||
|
|
<!-- Name each option, even the one you lean toward. Pros/cons per
|
||
|
|
option; a small dimension table (complexity, cost, maintenance,
|
||
|
|
familiarity) where it helps. Keep proportional to the decision. -->
|
||
|
|
|
||
|
|
## Decision
|
||
|
|
|
||
|
|
<!-- The choice, in one or two sentences. -->
|
||
|
|
|
||
|
|
## Consequences
|
||
|
|
|
||
|
|
<!-- What becomes easier, what becomes harder, what we will need to
|
||
|
|
revisit. Honest cons included. -->
|
||
|
|
|
||
|
|
<!-- Rules: an accepted ADR is never edited — write a new ADR that
|
||
|
|
supersedes it and set superseded_by here. Lasting directional
|
||
|
|
decisions only; feature-local choices belong in the design doc. -->
|