ADR 0000: Template¶
Status: Proposed Date: YYYY-MM-DD Issue: #NNNN
Copy this file to
docs/adr/NNNN-short-kebab-title.md, set the status, fill in each section, and add an entry todocs/adr/README.md. Runmake lint-docs-adrto confirm conformance.
Context¶
What is the situation that forces a decision? Surface the constraints, prior art, and tensions. Link to issues, design docs, and standards. A reader six months from now should be able to reconstruct why this was on the table, not just what got chosen.
Decision¶
State the chosen direction in one or two sentences. No hedging. The rest of the ADR justifies and qualifies it; the decision itself is the quotable summary.
Alternatives Considered¶
For each option that was seriously evaluated, capture:
- What it would have looked like — one sentence
- Why it was not chosen — one or two sentences
Record at least one alternative beyond "do nothing." If only one option was ever on the table, this probably did not need an ADR.
Consequences¶
What changes because of this decision? Cover both the upside the decision is reaching for and the costs the team is accepting. Include:
- Code, schema, or API surfaces that will move
- Operational or compliance implications
- Followups this decision unlocks or blocks
- Reversibility — how hard would it be to undo?