Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 1.95 KB

File metadata and controls

101 lines (70 loc) · 1.95 KB

ADR-XXXX: [Short Title in Title Case]

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

Date: YYYY-MM-DD

Deciders: [List of people involved in decision]

Related: [Links to related ADRs, if any]


Context

What is the issue that we're seeing that is motivating this decision or change?

This section should describe:

  • The forces at play (technical, political, social, project)
  • The trade-offs being considered
  • Why this decision is needed now
  • Who is affected by this decision

Decision

What is the change that we're proposing and/or doing?

This section should describe:

  • The specific choice being made
  • Key aspects of the solution
  • Why this option was chosen
  • How it will be implemented (high-level)

Alternatives Considered

What other options were considered?

For each alternative:

  • Describe the option
  • Explain why it wasn't chosen
  • Note any advantages it had

Alternative 1: [Name]

  • Description: ...
  • Pros: ...
  • Cons: ...
  • Why not chosen: ...

Alternative 2: [Name]

  • Description: ...
  • Pros: ...
  • Cons: ...
  • Why not chosen: ...

Consequences

What becomes easier or more difficult to do and any risks introduced by the change?

Positive Consequences

  • What benefits does this decision bring?
  • What becomes easier?
  • What problems does it solve?

Negative Consequences

  • What costs does this decision have?
  • What becomes harder?
  • What new problems might arise?

Risks

  • What could go wrong?
  • What are the mitigation strategies?

Technical Debt

  • What debt is this decision taking on?
  • When/how should it be revisited?

Implementation Notes

[Optional] Any specific notes about implementation:

  • Migration path from current state
  • Breaking changes
  • Rollout strategy
  • Testing strategy

References

[Optional] Links to:

  • Related documentation
  • External articles/resources
  • Discussion threads
  • Pull requests
  • Issues