Table of Contents

ADR-NNNN: Title

Status

Proposed

Context

Describe the background, constraints, problem, and forces that led to this decision.

Include relevant project goals, security considerations, maintainability concerns, deployment concerns, or template packaging concerns.

Decision

Describe the decision clearly and directly.

Use active language. Future readers should be able to understand what was chosen without reading the entire implementation.

Consequences

Document the expected results of the decision.

Include positive consequences, trade-offs, risks, and maintenance implications.

Alternatives Considered

List meaningful alternatives that were considered and why they were not selected.

Examples:

  • Alternative A: Reason it was not selected.
  • Alternative B: Reason it was not selected.

Link to related issues, pull requests, documentation, or source files when useful.