synvael/docs/adr/template.md
Serkyo cae434d227
Some checks are pending
CI / Rust Check & Lint (push) Waiting to run
CI / Rust Tests (push) Waiting to run
CI / Lua Lint & Format (push) Waiting to run
CI / LFS Pointer Guard (push) Waiting to run
docs(workspace): rewrite the subsystem notes and ADRs
2026-08-06 22:52:57 +02:00

872 B

NNNN.

  • Status: Proposed | Accepted | Deprecated | Superseded by ADR-XXXX
  • Date: YYYY-MM-DD

Context

Describe the forces at play. Outline the technical situation, the constraints we are working under, and the specific problem that requires a decision. Try to state the facts neutrally. What exactly makes this choice non-obvious, or why would it be hard to reverse later?

Decision

State the choice that we actually made. Use active, present tense ("The engine uses ...", "Worldgen seeds from ..."). Keep it to exactly one decision per record.

Consequences

Explain what becomes easier and what becomes harder as a result of this decision. You should include the trade-offs we accepted, any follow-on work this implies, and anything a future contributor must keep true in order for this decision to remain valid.