Architecture Decision Records (ADR)

This directory stores architecture decisions that have lasting impact on project structure, behavior, or contribution workflow.

Purpose

Use ADRs to capture:

  • Decision context
  • Chosen option
  • Alternatives considered
  • Consequences and follow-ups

ADRs avoid re-litigating the same design decisions and provide maintainers with historical rationale.

Status Values

Use one status per ADR:

  • Proposed
  • Accepted
  • Superseded
  • Rejected
  • Deprecated

Naming Convention

File pattern:

  • NNNN-short-kebab-case-title.md

Examples:

  • 0001-facade-overrides-platform-registrations.md
  • 0002-broadcasting-factory-consistency-strategy.md

Required Sections

Each ADR should include:

  1. Title
  2. Status
  3. Date
  4. Context
  5. Decision
  6. Alternatives Considered
  7. Consequences
  8. Follow-up Actions

ADR Index

When adding new ADRs, append them to this index.