ADR-NNNN:
-
Status: Proposed Accepted Superseded by ADR-XXXX Deprecated - Date: YYYY-MM-DD
- Deciders: <names / roles>
- Related: <Jira keys, ADRs, RFC summary, design docs>
Context
What is the problem or force that motivates this decision? Describe the constraints (technical, organizational, timeline), the state of the code at the time, and anything a reader needs in order to understand why a decision was needed. State facts, not the decision itself.
Decision
The choice that was made, in the active voice: “We will …”. Be specific enough that a reader can tell whether the current code follows the decision. Reference the concrete types, packages, or fields the decision maps to.
Alternatives considered
For each option that was seriously weighed:
- Option name — what it was, and why it was not chosen (or why the chosen option beat it). Honest trade-offs, not strawmen.
Consequences
- Positive: what gets easier or safer.
- Negative / costs: what gets harder, what debt we take on.
- Follow-ups: work this decision creates or defers (link Jira where known).
References
- Code:
path/to/file.go - Design docs / RFC:
- Jira: