ADR-NNNN: [Title]¶
Status: Proposed | Accepted | Deprecated | Superseded
Date: YYYY-MM-DD
Deciders: [List of people involved in the decision]
Supersedes: [ADR-XXXX if this supersedes another]
Superseded by: [ADR-XXXX if this has been superseded]
Context¶
What is the issue that we're seeing that is motivating this decision or change? Include relevant background, constraints, and forces at play.
Decision¶
What is the change that we're proposing and/or doing? State the decision clearly and concisely.
Consequences¶
Positive¶
- What becomes easier or better?
- What new capabilities does this enable?
Negative¶
- What becomes harder or worse?
- What are the trade-offs?
- What technical debt does this introduce?
Neutral¶
- What other changes might be needed as a result?
- What areas of the codebase are affected?
References¶
- Links to relevant code files
- Links to external documentation
- Links to issues or discussions
Notes¶
Alternatives Considered¶
- Alternative A: Brief description and why it was not chosen.
- Alternative B: Brief description and why it was not chosen.