Development Workflow¶
This project uses: - GitHub Flow - Lightweight Scrum - Continuous re-entry workflow
Work cycle¶
- Re-entry (
README_REENTRY.md) - Check state (
PROJECT_STATE.md) - Create/open issues for the active HU
- Start services (
make -C ops up) - Develop + tests + documentation
- Open PR with DoR/DoD checklist
- CI: lint + test (verify GitHub Actions are green)
-
Review PR → merge → update
Sprint_Log.mdandPROJECT_STATE.md -
Base branch:
develop(feature branches start here; no direct commits ondevelop) - Branch naming:
type/huNN-short-desc(example:feat/hu17-unify-suggestions-summary) - Flow: branch from
develop→ PR/merge back todevelop;mainupdates only fromdevelopat releases/checkpoints
Scalability¶
This workflow supports additional collaborators with minimal changes.
Audit Policy (Canonical)¶
- Default mode: NORMAL (warnings do not block work).
- Strict mode: run only before:
- merging into canonical branches (e.g., develop/main), or
- starting a large feature (contract/db/cross-cutting changes).
Definition of “large feature”: - modifies API/event contracts - touches DB/models/migrations - includes mass renames/deletes (R/D) - cross-layer refactors (routes/controllers/services/events/tests) - introduces new external integration