Skip to main content

Branching and PR Workflow

Last reviewed: 2026-04-21
Maintained by: Engineering

Branching​

Create a feature branch from latest main:

git checkout main
git pull --ff-only
git checkout -b feat/short-description

Suggested branch prefixes:

  • feat/
  • fix/
  • chore/
  • docs/

Commits​

Use clear, scoped commit messages:

git add .
git commit -m "feat(manager-desk): add onboarding modal"

Pull Request Checklist​

  • Relevant local checks are green.
  • Changes are scoped to requested feature/fix.
  • If DB changed: migration + schema drift handled.
  • If docs-impacting changes exist: docs updated in same PR.
  • PR description includes:
    • what changed
    • what was verified
    • any non-blocking follow-ups

Documentation Impact Rule​

If the PR changes scripts, env vars, ports, migrations, or startup flow, include docs update in the same PR or explicitly add:

No documentation impact: <reason>

For full policy see: documentation-policy.md