| name | commit |
| description | Create Git commits by splitting changes into logical units following project conventions. Handles Git Flow automatically — detects develop branch and checks out a feature branch before committing. |
| allowed-tools | Bash |
Step 0 — Branch Check (Required)
Check the current branch first:
git branch --show-current
If current branch is develop:
This project uses Git Flow. Feature branches must be created from develop and merged back into develop.
- Analyze all changes with
git status and git diff
- Infer an appropriate branch name from the changes:
- Format:
<type>/<kebab-case-description> — use the same type as the planned commit
- Reflect the domain scope in the name
- Examples:
add/add-team-list-api, fix/auth-login-bug, update/optimize-seat-query
- Create and checkout the branch:
git checkout -b <type>/<inferred-name>
- Proceed with the commit flow below
If current branch is NOT develop: proceed directly to the commit flow.
Commit Message Rules
Format: type :: description
- Git Commit Message Keyword
| Type | Meaning |
|---|
add | 새로운 코드나 파일을 추가하였을 때 |
update | 기존의 코드를 수정했을 때 |
fix | 버그를 수정했을 때 |
delete | 삭제한 사항이 있을 때 |
docs | 문서를 수정 |
test | 테스트 관련 사항을 추가/수정하였을 때 |
merge | 브랜치를 병합하였을 때 |
init | 프로젝트 초기화 시 |
- Message examples:
add :: 거래 상태 변경 알림 전송 추가update :: 거래 상태 이벤트 수신 대상 분리fix :: 내부 API 헤더 검증 오류 수정
- Description: Korean, no period, use noun-ending style; forbidden endings:
~한다/~된다, ~하기, ~합니다/~됩니다, ~했습니다
- Good:
엔티티 필드 추가, 트랜잭션 롤백 방지, 로직 개선
- Subject line only (no body)
- Do NOT add AI as co-author
Commit Flow
- Inspect changes:
git status, git diff
- Group changed files by logical unit of change:
- Same feature or bug fix → one commit
- Related files that must change together (e.g. entity + service + controller for one feature) → one commit
- Unrelated changes → separate commits
- For each logical group:
- Stage the relevant files:
git add <file1> <file2> ...
- Write a commit message that describes the change as a whole
git commit -m "message"
- Verify with
git log --oneline -n <count>
Rule: One logical change = One commit. Files that must change together belong in the same commit. Unrelated changes must be split.
