Skip to content

Local Development Loop

Use this workflow for fast and reliable daily development.

Loop

flowchart LR
    A["Write or update endpoint"] --> B["Run local server"]
    B --> C["Exercise endpoint (docs/curl/tests)"]
    C --> D["Run lint and tests"]
    D --> E["Commit with focused change"]
    E --> A

Commands

# run docs/dev server
hatch run docs:serve

# run tests
hatch run test:test

# run lint and format
hatch run ruff check .
hatch run format

Daily checklist

  1. Keep each change small and scoped.
  2. Validate OpenAPI output when request/response models change.
  3. Add or update at least one test for behavior changes.