Skip to content

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records for the auto-pr project.

Each ADR is a markdown file named NNNN-title-with-dashes.md where NNNN is a zero-padded number. See adr-template.md for the template (MADR 4.0.0 minimal).

When creating or editing ADRs, follow the workflow in AGENTS.md.

ADRTitle
0000Template
0001Functional Core / Imperative Shell and Effect
0002Two-phase auto-PR workflow
0003Bun as package manager and test runner
0004Workflow pin automation
0005Build and dist management
0006Nix CI: upstream Nix and caching
0007Config-driven AI provider abstraction
0008Configuration: env vars; config file deferred
0009Ollama removal and OpenAI-compat-only LanguageModel
0010Extract auto-pr from paperless-ingestion-bot
0011GitContext service and AI diff tool use
0012Documentation website with Starlight on GitHub Pages
0013Transient vs permanent AI error classification

These documents inform or support decisions but are not ADRs. They live in supporting/:

DocumentPurpose
bun-migration-plan.mdPlan: Bun migration (complete; see ADR 0003)
build-plan-2026.mdPlan: build tool research (tsdown vs Bun.build; implemented via Bun.build)
determinate-nix-migration-plan.mdPlan: migration to Determinate Nix (if adopted)
nix-ci-research.mdResearch: Nix CI best practices assessment
nix-workflow-upstream-actions.mdResearch: replacing nix.yml steps with upstream actions
workflow-best-practices.mdResearch: GitHub Actions workflow best practices
commit-ordering-for-ai-prompt.mdDesign: sort/filter commits by type before AI prompt to reduce position bias