Commit Changes
Pre-checks
- •Run
git statusto see changes - •Stop and do not commit if the local branch is
mainor is tracking the remotemainbranch - •Run
git diff --statfor summary
Commit Type
- •
feature: New feature - •
fix: Bug fix - •
docs: Documentation only - •
style: Formatting, no code change - •
refactor: Code change that neither fixes nor adds - •
test: Adding or updating tests - •
chore: Maintenance tasks
Scopes
- •
api- Backend API changes - •
domain- Domain logic changes - •
infra- Infrastructure/data access changes - •
web- Frontend React app changes - •
db- Database schema changes - •
modules/<name>- Specific module changes
Format
code
<type>(<scope>): <description>
Rules
- •Keep description under 72 characters
- •Use imperative mood ("add" not "added")
- •Use proper capitalisation and grammar
- •Reference issue numbers if applicable:
fix(api): resolve null reference (#123) - •For breaking changes, add
!after scope:feat(api)!: change auth flow
Examples
code
feat(modules/budget): Add monthly budget comparison view fix(domain): Correct balance calculation for splits refactor(web): Migrate account list to SectionTable component chore: Update npm dependencies