Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (41 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.28 KB
Raw

Contributing

Thanks for improving Ledger Sync. Keep changes focused and verify the affected behavior plus both quality gates before opening a PR.

Setup

corepack enable
pnpm install
pnpm run setup
pnpm run dev

Local services:

Use .env.example as the template. Put backend values in backend/.env. Local frontend development needs no environment file because Vite proxies /api; use frontend/.env.local only when testing a separate API origin. Never commit real secrets or .env files.

Checks

Run the full project check before submitting:

pnpm run check
pnpm run build

Backend-only:

cd backend
uv run ruff check .
uv run mypy src/
uv run pytest tests/ -v

Frontend-only:

cd frontend
pnpm run lint
pnpm run type-check
pnpm test
pnpm run build

Pull Requests

  • Keep changes surgical and tied to one problem.
  • Use conventional commits such as fix: update onboarding docs.
  • Include what changed, why, and the checks you ran.
  • Update API, page, calculation, database, deployment, or changelog documentation when a change affects those contracts.
  • Do not include generated caches, local databases, node_modules, or secrets.