Skip to content

ADR-XXXX: [Short Title]

Status

[Proposed | Accepted | Deprecated | Superseded by ADR-YYYY]

Context

What is the issue that we're seeing that is motivating this decision or change? 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.

Decision

What is the change that we're proposing and/or doing? This section describes our response to these forces. It is stated in full sentences, with active voice. "We will ..."

Consequences

What becomes easier or more difficult to do because of this change? 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.

Alternatives Considered

What other options did we evaluate? Why were they not chosen? This helps provide context for future readers about the decision-making process.

References

  • Links to relevant documentation
  • Related ADRs
  • External resources that informed this decision