Initial template setup
This commit is contained in:
@@ -0,0 +1,18 @@
|
||||
# ADR-0001: Example ADR
|
||||
|
||||
**Date:** 2026-05-09
|
||||
**Status:** accepted
|
||||
|
||||
## Context
|
||||
|
||||
This is an example to show the ADR shape. Replace with your real first decision and renumber the file accordingly.
|
||||
|
||||
## Decision
|
||||
|
||||
Use the ADR pattern from Michael Nygard's article ("Documenting Architecture Decisions"): short, context-then-decision-then-consequences, one decision per file, append-only.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Decisions are searchable and history-stable
|
||||
- Old decisions stay readable even after they're superseded
|
||||
- New contributors can read the ADR folder to understand "why is this the way it is"
|
||||
@@ -0,0 +1,7 @@
|
||||
# Architecture Decision Records
|
||||
|
||||
One file per decision, append-only. Status flows: `proposed` → `accepted` → optionally `superseded`/`deprecated`.
|
||||
|
||||
| ID | Title | Status | Date |
|
||||
|---|---|---|---|
|
||||
| [ADR-0001](ADR-0001-example.md) | Example ADR | accepted | 2026-05-09 |
|
||||
Reference in New Issue
Block a user