66 lines
1.6 KiB
Markdown
66 lines
1.6 KiB
Markdown
# 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:
|
|
|
|
```markdown
|
|
# 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-*.md`
|
|
- `adr-002-*.md`
|
|
- etc.
|
|
|
|
## Creating a New ADR
|
|
|
|
1. Create a new file: `adr-XXX-short-title.md`
|
|
2. Use the template above
|
|
3. Set status to "Proposed"
|
|
4. Create a PR for discussion
|
|
5. Update status to "Accepted" after approval
|
|
|
|
## ADR Lifecycle
|
|
|
|
1. **Proposed**: Initial proposal, under discussion
|
|
2. **Accepted**: Decision has been made and approved
|
|
3. **Deprecated**: Decision is no longer followed
|
|
4. **Superseded**: Replaced by a newer ADR
|
|
|
|
## Current ADRs
|
|
|
|
*No ADRs yet. Create the first one using the template above.*
|
|
|
|
## References
|
|
|
|
- [ADR Template](https://github.com/joelparkerhenderson/architecture-decision-record)
|
|
- [Documenting Architecture Decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
|
|
|