Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (19 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.03 KB
Raw

Contributing

Small, focused pull requests are welcome. This is an alpha integration against an unofficial and changing backend, so tests and clear failure behavior matter more than clever abstractions.

Setup

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
python -m ruff check .
python -m pytest -q
python -m build

Expectations

  • Keep categorization and transfer logic deterministic and explainable.
  • Keep the core independent of Firestore, the CLI, and local persistence.
  • Add tests for changed behavior, especially ties, date boundaries, currencies, stale writes, and idempotency.
  • Use synthetic fixtures only. Never commit or paste real Spendee responses or financial data.
  • Preserve dry-run defaults and require explicit --commit for remote changes.
  • Update the README when changing CLI behavior or configuration.

AI coding agents should read README.md, SECURITY.md, and the relevant pure module before editing. Run the complete validation sequence before handing changes back.