Skip to content

Workflow

Scope

This workflow applies to backend work in this repository: app/, db/, tests/, postman/, and backend docs.

Branch and PR flow

  1. branch from main
  2. keep changes focused
  3. update docs when behavior, architecture, or operations change
  4. open a PR with test and rollout evidence

The repository already includes:

  • .github/pull_request_template.md
  • .github/CODEOWNERS
  • backend CI workflows under .github/workflows/

Required local checks

Run the checks relevant to backend changes:

ruff check .
pytest
python postman/check_sync.py
mkdocs build

python postman/check_sync.py is required when backend routes change. CI enforces that policy.

Route-change policy

If you modify:

  • app/api/router.py
  • app/api/routers/**

then also update:

  • postman/collection.json
  • postman/README.md
  • environment files if auth or variables changed

Documentation expectations

When backend behavior changes, update the page that owns that behavior:

  • architecture pages for subsystem changes
  • runbooks for operational changes
  • current-state page when the deployed shape changes

Historical or archived documents are not a substitute for updating the active docs tree.