Skip to main content

Template

Changelog​

  • {date}: {changelog}

Context​

This section describes the forces at play, including technological, political, social, and project local. These forces are probably in tension, and should be called out as such. The language in this section is value-neutral. It is simply describing facts. {context body}

Decision​

This section describes our response to these forces. It is stated in full sentences, with active voice. "We will ..." {decision body}

Status​

A decision may be "proposed" if the project stakeholders haven't agreed with it yet, or "accepted" once it is agreed. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement. {Deprecated|Proposed|Accepted}

Consequences​

This section describes the resulting context, after applying the decision. All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future.

Positive​

{positive consequences}

Negative​

{negative consequences}

Neutral​

{neutral consequences}

References​

A list of relevant PRs, issues that led up to this, or articles referenced for why we made the given design choice? A list of external reference links for any included above in [markdown reference format][ref-slug-or-number]

[ref-slug-or-number]: http://example.org/reference/link

  • {reference link}
  • {markdown references}