Architecture Decision Records

This section contains Architecture Decision Records (ADRs) documenting significant decisions made in this project.

Index

• ADR-001: pnpm Workspaces
• ADR-002: oxlint and oxfmt
• ADR-003: ES Modules
• ADR-004: Vitest over Jest
• ADR-005: Changesets for Versioning

What is an ADR?

An Architecture Decision Record (ADR) is a lightweight design document capturing an important architectural decision along with its context, decision rationale, and consequences.

Format

Each ADR follows this structure:

• Title: Brief description of the decision
• Date: When the decision was made
• Status: Proposed, Accepted, Deprecated, Superseded
• Context: Problem or situation requiring the decision
• Decision: What was decided
• Rationale: Why this decision was made
• Consequences: Positive and negative impacts
• Alternatives Considered: Other options evaluated

Status Values

• Proposed: Under discussion
• Accepted: Decision agreed upon and implemented
• Deprecated: No longer recommended
• Superseded: Replaced by another decision

Reading ADRs

Start with the index above and read ADRs in order. Each ADR builds upon previous decisions.