What problem does it solve?
Inconsistent branch names, unclear PR scope, and oversized pull requests make reviews slow and break automatic project linking, causing delays in development and fragile release flows.
Core Features & Use Cases
- Branch naming conventions: Clear patterns for milestone, task, and hotfix branches to ensure kebab-case, inclusion of issue numbers when required, and protected branch behavior.
- Branch flow and linking: Defines how to create task branches from milestone branches, open PRs to milestone and staging, and use issue numbers in branch names so GitHub Projects link and PR keywords close issues automatically.
- PR size policy & best practices: Guidance on target PR size, how to slice large changes, review expectations, and rules to avoid direct pushes to protected branches.
- Use Case: When implementing a new coupon feature, create a milestone branch for the feature, spawn task branches for each subtask with the issue number in the name, open focused PRs for each task, and then open a final PR from the milestone to staging.
Quick Start
Create a task branch from the corresponding milestone branch named task/coupon-engine/456-create-endpoint, open a PR to milestone/coupon-engine with a concise description and include the phrase Closes #456 in the PR body.