synvael/docs/adr/template.md

17 lines
716 B
Markdown

# NNNN. <short decision title>
- **Status:** Proposed | Accepted | Deprecated | Superseded by [ADR-XXXX](XXXX-...)
- **Date:** YYYY-MM-DD
## Context
The forces at play: the technical situation, the constraints, and the problem that requires a decision. State the facts neutrally. What makes this choice non-obvious or hard to reverse later?
## Decision
The choice that was made, stated in the active, present tense ("The engine uses …", "Worldgen seeds from …"). One decision per record.
## Consequences
What becomes easier and what becomes harder as a result. Include the trade-offs accepted, the follow-on work implied, and anything a future contributor must keep true for the decision to remain valid.