Skip to content

README.md

Latest commit

 

History

History
21 lines (14 loc) · 733 Bytes

README.md

File metadata and controls

21 lines (14 loc) · 733 Bytes

Architecture Decision Records

This directory contains system-wide architecture decisions for this repository.

Canonical Placement

  • ADR template: docs/templates/adr.md
  • ADR entry: docs/adrs/{NNNN}-{decision-title}.md
  • Example: docs/adrs/0001-initial-architecture-decision.md

File Convention

  • Use one file per decision in docs/adrs/
  • Example file: 0001-initial-architecture-decision.md
  • Update the ADR in place when the decision evolves

How to Use

  1. Copy docs/templates/adr.md and create docs/adrs/{NNNN}-{decision-title}.md.
  2. Fill context, choice, and rationale.
  3. When a decision changes, update the existing ADR rather than creating a new one.