Skip to content

0000-template.md

Latest commit

 

History

History
37 lines (22 loc) · 1.32 KB

0000-template.md

File metadata and controls

37 lines (22 loc) · 1.32 KB

ADR-NNNN:

  • Status: Proposed | Accepted | Superseded by ADR-NNNN | Deprecated
  • Date: YYYY-MM-DD
  • Affects: <list packages, files, or surfaces this decision constrains>

Context

What forces are at play? What's the current state of the world that makes this decision necessary? Keep it factual — describe the problem, not the solution.

Decision

What did we decide? State it plainly, in one or two sentences. Then list the concrete rules / constraints that flow from this decision.

Consequences

What changes because of this decision? Both:

  • Positive — what becomes easier or possible.
  • Negative — what becomes harder, what we now have to maintain, what trade-off we accepted.

Don't pretend a decision has no downsides. The honest cost is what makes the ADR useful when someone later wonders "why didn't we just do X?".

Alternatives considered

What did we reject, and why?

  • Alternative A — short description. Rejected because: .
  • Alternative B — short description. Rejected because: .

If there were no real alternatives, write that. If the decision is reversible, note that too.

See also

  • Related ADRs: ADR-NNNN, ADR-NNNN
  • Related code: path/to/file.js, cppjs-packages/cppjs-package-X/
  • External references: links, issues, PRs