Skip to content

adrs.md

Latest commit

 

History

History
34 lines (24 loc) · 1.69 KB

adrs.md

File metadata and controls

34 lines (24 loc) · 1.69 KB

Architecture decisions

Sunscreen's design rationale lives in Architecture Decision Records (ADRs) in docs/adr/.

Current ADRs

ID Title Status
ADR-0001 The sunscreen CLI: scope, vision, principles Accepted
ADR-0002 CLI design conventions (exit codes, flags, JSON contract) Accepted
ADR-0003 Documentation strategy Accepted
ADR-0004 Incremental scaffolding (markers) Accepted
ADR-0005 Beginner onboarding surface Accepted
ADR-0006 Pinocchio bootstrap Accepted

ADR format

Each ADR has:

  • A meta table (status, date, authors, tags, supersedes, related).
  • TL;DR.
  • Context.
  • Decision drivers.
  • Considered options.
  • Decision.
  • Consequences.

Template: see ADR-0001.

Writing a new ADR

Open a PR adding docs/adr/ADR-NNNN-<slug>.md, status Proposed. Discuss in the PR. When merged, status flips to Accepted. If a later ADR overrides it, set Status: Superseded by ADR-NNNN rather than deleting.

ADRs document why we chose what we chose, not how to use the code. For user-facing docs, contribute to this site instead.