Architecture Decision Records
This directory contains Architecture Decision Records (ADRs) for The Order project.
What is an ADR?
An Architecture Decision Record is a document that captures an important architectural decision made along with its context and consequences.
ADR Format
Each ADR should follow this structure:
# ADR-XXX: [Title]
## Status
[Proposed | Accepted | Deprecated | Superseded]
## Context
Describe the issue that is motivating this decision or change.
## Decision
State the architectural decision that is being made.
## Consequences
Describe the consequences, both positive and negative, of this decision.
## Alternatives Considered
List alternatives that were considered and why they were rejected.
## References
Links to related ADRs, issues, or documentation.
ADR Numbering
ADRs are numbered sequentially:
adr-001-*.mdadr-002-*.md- etc.
Creating a New ADR
- Create a new file:
adr-XXX-short-title.md - Use the template above
- Set status to "Proposed"
- Create a PR for discussion
- Update status to "Accepted" after approval
ADR Lifecycle
- Proposed: Initial proposal, under discussion
- Accepted: Decision has been made and approved
- Deprecated: Decision is no longer followed
- Superseded: Replaced by a newer ADR
Current ADRs
No ADRs yet. Create the first one using the template above.