Pull Requests
PR Title
Use Conventional Commit format, same as commit messages:
text
<type>(<scope>): <description>
Types
- •
feat: User-facing features or behavior changes (must change production code) - •
fix: Bug fixes (must change production code) - •
docs: Documentation only - •
style: Code style/formatting (no logic changes) - •
refactor: Code restructuring without behavior change - •
test: Adding or updating tests - •
chore: CI/CD, tooling, dependency bumps, configs (no production code)
PR Description Template
markdown
## Summary One sentence describing the overall change. - Optional supporting details - If needed ## Test plan - [ ] How to verify it works
Labels
Apply labels using gh pr create --label <label> or gh pr edit --add-label <label>.
Apply all labels that fit. Only use these labels:
- •
enhancement- User-facing features or improvements (must change production code behavior) - •
refactor- Production code changes that don't alter behavior - •
bug- Fixes broken production code functionality - •
test- Changes to tests - •
documentation- Documentation changes
No label needed for dependency bumps, CI/CD, tooling, or infrastructure changes - these go in "Other Changes" in release notes.
Branch Naming
Use type/short-description:
text
feat/infinite-scroll fix/album-path-validation chore/pre-commit-hooks
Instructions
- •Run
git log main..HEADto see commits for this branch - •Run
git diff main...HEADto see all changes - •Summarize the changes in 1-2 sentences
- •Create a test plan with verification steps
- •Apply appropriate labels