2.5 KiB
2.5 KiB
trigger, description
| trigger | description |
|---|---|
| model_decision | When creating branches, committing code, managing PRs, or working with version control |
Git Workflow Principles
Commit Messages — Conventional Commits
Format:
<type>(<scope>): <description>
[optional body]
[optional footer]
Types:
| Type | Purpose |
|---|---|
feat |
New feature |
fix |
Bug fix |
docs |
Documentation only |
style |
Formatting, semicolons, etc. |
refactor |
Code change (no new feature/fix) |
test |
Adding or updating tests |
chore |
Maintenance, dependencies |
perf |
Performance improvement |
ci |
CI/CD configuration changes |
Rules:
- Description is imperative mood ("add" not "added", "fix" not "fixes")
- Scope matches the feature area (e.g.,
task,auth,ui) - Description is concise (<72 characters)
- Body explains why, not what (the diff shows what)
Branch Naming
Format: <type>/<ticket-or-short-description>
Examples:
feat/task-crud-api
fix/auth-token-expiry
refactor/storage-layer
chore/update-deps
Rules:
- Use lowercase with hyphens (kebab-case)
- Prefix matches commit type
- Keep branch names short but descriptive
Commit Hygiene
- One logical change per commit — don't mix unrelated changes
- Never commit broken tests — all tests must pass before committing
- Don't commit debug code — remove console.log, print statements, TODO hacks
- Don't commit secrets — use
.gitignoreand environment variables
PR Size Guidelines
- Ideal: <400 lines changed
- Acceptable: 400-800 lines
- Too large: >800 lines — split into smaller PRs
Why: Large PRs get rubber-stamped. Small PRs get thoughtful reviews.
Merge Strategy
- Feature branches → main: Squash merge (clean history)
- Release branches: Merge commit (preserve history)
- Hotfixes: Cherry-pick to affected branches
Git Workflow Checklist
- Branch named with correct type prefix?
- All commits follow conventional format?
- No debug code or secrets committed?
- All tests pass before committing?
- PR is <400 lines (or justified if larger)?
- Commit messages explain why, not just what?
Related Principles
- Code Completion Mandate @code-completion-mandate.md
- Testing Strategy @testing-strategy.md
- Security Mandate @security-mandate.md