Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.09 KB

File metadata and controls

48 lines (35 loc) · 2.09 KB

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records (ADRs) for the Cambridge Beer Festival app.

What is an ADR?

An Architecture Decision Record (ADR) is a document that captures an important architectural decision made along with its context and consequences.

ADRs help us:

  • Document why decisions were made (not just what)
  • Preserve context for future team members
  • Track alternatives that were considered
  • Enable reversal by understanding original reasoning
  • Learn from outcomes of past decisions

Format

Each ADR follows this structure:

  • Status: Proposed | Accepted | Deprecated | Superseded
  • Date: When the decision was made
  • Context: What forces are at play (technical, political, social, project local)
  • Decision: What we decided to do
  • Consequences: What becomes easier or harder as a result

ADR Index

ADR Title Status Date
0001 GitHub Actions Caching Strategy Accepted 2025-12-27
0002 Composite Actions and Test Deduplication Accepted 2025-12-27
0003 Parallel Build Strategy for Android Releases Accepted 2025-12-27
0004 Path-Based URL Strategy for Deep Linking Accepted 2025-12-21
0005 E2E Testing Strategy (Playwright for URL Smoke Tests) Accepted 2025-12-21

Creating a New ADR

  1. Copy the template (if exists) or use previous ADR as reference
  2. Number sequentially: 0002-title.md, 0003-title.md, etc.
  3. Fill in all sections, especially alternatives considered
  4. Update this index with a link
  5. Get team review before marking as "Accepted"

References