Skip to content

AutoBudget Developer Handbook

Everything you need to build, run, test, and modify AutoBudget.

Contents

  1. Getting started — requirements, build, run, tests, CI notes. First contact or environment trouble.
  2. Codebase map — orientation notes + extension recipes. Read when adding or fixing a bank rule, currency, keyword, screen, setting, or DB migration.
  3. Testing — test inventory, golden fixtures, writing tests. Read before adding or changing any test.
  4. Releasing — versioning, semantic-release, signing, Play upload. Read when cutting or re-cutting a release.

Orientation

  • Architecture — start with docs/architecture/overview.md, then the topic docs (data layer, ingestion pipeline, parser, classification, money, UI, security, tooling).
  • Decisions — every decision is an ADR under docs/adr/ — read before changing behavior in that area, and write a new ADR when you change one.
  • Domain vocabulary — CONTEXT.md defines the glossary; use those exact terms in code, issues, and tests.