Skip to content

Open-source status page, incident response and uptime monitoring

1.5 KB
Raw Blame

Optional metadata. Remove any element you don't need.

status: "{proposed | rejected | accepted | deprecated | superseded by ADR-NNNN}" date: { YYYY-MM-DD when the decision was last updated } decision-makers: { everyone involved in the decision } consulted: { subject-matter experts consulted, with two-way communication } informed: { people kept up to date, with one-way communication }

{short title, representative of the problem and the chosen solution}

Context and Problem Statement

{Two or three sentences, or a short story, describing the context and the problem. Framing the problem as a question often helps. Link issues/PRs.}

Decision Drivers

  • {driver 1 — a force, a concern, a constraint}
  • {driver 2}

Considered Options

  • {option 1}
  • {option 2}
  • {option 3}

Decision Outcome

Chosen option: "{option N}", because {justification — meets a must-have driver, resolves a key force, or comes out best in the comparison below}.

Consequences

  • Good, because {positive consequence}
  • Bad, because {negative consequence / accepted trade-off}

Confirmation

{How compliance with this ADR is checked — a review, a test, a lint rule, a sign-off.}

Pros and Cons of the Options

{option 1}

  • Good, because {argument}
  • Neutral, because {argument}
  • Bad, because {argument}

{option 2}

  • Good, because {argument}
  • Bad, because {argument}

More Information

{Extra evidence, team agreement, when to revisit, links to related ADRs.}