Skip to content

Latest commit

 

History

History
98 lines (59 loc) · 1.68 KB

File metadata and controls

98 lines (59 loc) · 1.68 KB

ADR-0000: Template

Date: YYYY-MM-DD
Status: Proposed | Accepted | Superseded | Deprecated | Rejected
Deciders: (list the people or teams involved in the decision)
Supersedes: (ADR number and link, if this replaces an earlier decision)
Superseded by: (ADR number and link, if a later ADR replaces this one)


Context

Describe the situation or problem that led to this decision. Include any technical constraints, business requirements, or forces at play. Be specific enough that someone unfamiliar with the codebase can understand the problem without reading other documents.


Decision Drivers

  • Driver 1 (e.g., performance requirement, operational simplicity)
  • Driver 2
  • Driver 3

Options Considered

Option A — (short name)

Brief description of the option.

Pros:

  • Pro 1
  • Pro 2

Cons:

  • Con 1
  • Con 2

Option B — (short name)

Brief description of the option.

Pros:

  • Pro 1

Cons:

  • Con 1

Option C — (short name, if applicable)

Brief description of the option.

Pros:

  • Pro 1

Cons:

  • Con 1

Decision

State the chosen option clearly:

We will use Option X because …

Explain the primary reason(s) for the choice, referencing the decision drivers above.


Consequences

Positive

  • What becomes easier or better as a result.
  • What risks are mitigated.

Negative / Trade-offs

  • What becomes harder, more complex, or constrained.
  • Known limitations or future debt introduced.

Neutral / Notes

  • Follow-up work required.
  • Decisions this record leaves open.

Links

  • Related issue or PR: #
  • Related documentation: (link)
  • Prior art / reference: (link)