Architecture Decision Records (ADRs)¶
This directory contains lightweight records of architectural decisions made during development.
What is an ADR?¶
An Architecture Decision Record (ADR) captures a single architectural decision and its context. ADRs are:
- Immutable: Once accepted, they are not modified (superseded by new ADRs instead)
- Focused: Each ADR covers one decision
- Concise: Brief format focusing on decision and rationale
ADR vs RFC¶
- ADR: Records a decision already made or being made (lightweight, focused)
- RFC: Proposes a comprehensive solution for review (detailed, exploratory)
Use ADRs for specific technical decisions. Use RFCs for major features or system changes.
Format¶
ADRs use the format:
NNNN-title-of-decision.md(e.g.,0001-use-docker-for-lambda.md)- Numbered sequentially
- Brief title in kebab-case
ADRs¶
| ADR | Title | Status | Date |
|---|---|---|---|
| - | - | - | - |
Template¶
See template.md for the ADR template.
Submitting an ADR¶
See the Documentation Submission Workflow guide for detailed step-by-step instructions on the two-PR process.
Related Documentation¶
- See RFCs for proposals under review
- See Architecture Plans for approved designs