Skip to content

feat: add Architecture Decision Records (ADRs) template#78

Merged
PAMulligan merged 2 commits intomainfrom
15-add-architecture-decision-records-adrs-template
Apr 13, 2026
Merged

feat: add Architecture Decision Records (ADRs) template#78
PAMulligan merged 2 commits intomainfrom
15-add-architecture-decision-records-adrs-template

Conversation

@PAMulligan
Copy link
Copy Markdown
Contributor

@PAMulligan PAMulligan commented Apr 13, 2026

Summary

  • Add docs/adr/ directory with a standard ADR template (000-template.md) and index (README.md)
  • Document three key architectural decisions as initial ADRs:
    • ADR-001: Hono as HTTP framework over Express — edge-first design, TypeScript-native, single framework for Workers + Node.js
    • ADR-002: Drizzle ORM over Prisma and TypeORM — TypeScript schema as source of truth, zero runtime overhead, drizzle-zod integration
    • ADR-003: TDD as a mandatory pipeline gate — tests verify the OpenAPI spec, coverage by design, prevents generated code drift
  • Link ADR section from docs/onboarding/architecture.md

Test plan

  • Verify all internal markdown links resolve (ADR index → individual ADRs, architecture.md → ADRs)
  • Verify external link to Michael Nygard's ADR blog post is reachable
  • Confirm CI passes (structure validation + markdown link check)
  • Review ADR content accuracy against pipeline.config.json and existing documentation

🤖 Generated with Claude Code

@claude
feat: add Architecture Decision Records (ADRs) template and initial d…
500cab9 
…ecisions

Add docs/adr/ directory with a standard ADR template and three initial
ADRs documenting key architectural decisions: Hono over Express,
Drizzle over Prisma/TypeORM, and TDD as a mandatory pipeline gate.
Link from the onboarding architecture guide.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan linked an issue Apr 13, 2026 that may be closed by this pull request
Add architecture decision records (ADRs) template #15
Closed
6 tasks
@github-actions github-actions bot added the area: docs Documentation label Apr 13, 2026
@claude
fix: remove placeholder link in ADR template that breaks lychee
674ab77 
Replace the `[ADR-NNN](NNN-title.md)` markdown links with plain text
so the CI link checker does not try to resolve the placeholder path.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan self-assigned this Apr 13, 2026
@PAMulligan PAMulligan merged commit efe2800 into main Apr 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@PAMulligan PAMulligan

Labels

area: docs Documentation

Projects

PMDS Open Source Roadmap
Status: Done

Milestone

v0.6.0 — Developer Experience

Development

Successfully merging this pull request may close these issues.

Add architecture decision records (ADRs) template

1 participant

@PAMulligan