What problem does it solve?
Enforces a consistent, auditable git commit and promotion workflow so contributors avoid broken releases, diverging histories, and unsafe repository changes.
Core Features & Use Cases
- Branch flow enforcement: mandates feature/* and hotfix/* branching patterns and forbids direct pushes to staging or main.
- Commit and PR standards: requires conventional commit messages with scopes, Co-Authored-By attribution, and pre-commit test verification.
- Promotion rules and merge strategies: defines promotion PR bases and uses squash merges for feature→dev and merge commits for dev→staging and staging→main to preserve SHAs.
- Use Case: A mobile engineer preparing a feature branch runs tests, commits with the prescribed format, opens a PR to dev, and relies on the workflow to promote changes through staging to production safely.
Quick Start
Create a feature branch, run the project test suites until green, commit using the conventional message format including Co-Authored-By, and open a PR to dev following the branch and PR rules.