Commit Message Helper
형식
():
[변경 이유(WHAT이 아닌 WHY)를 설명하는 선택적 본문]
유형
| 유형 | 사용 예 |
|---|---|
feat | 새 기능 |
fix | 버그 수정 |
docs | 문서 변경 |
style | 코드 포맷팅, 로직 변경 없음 |
refactor | feat/fix 없는 코드 변경 |
test | 테스트 추가 또는 업데이트 |
chore | 유지보수 (의존성, 설정) |
규칙
- 제목: 최대 72자, 명령형 어조 ("added"가 아닌 "add")
- 범위(scope)는 선택 사항이지만 권장 (예:
auth,api,ui) - 본문은 무엇이 아닌 이유를 설명 (diff가 무엇을 보여줌)
- 커밋당 하나의 논리적 변경
워크플로우
git diff --staged실행하여 스테이징된 변경사항 확인- 주요 유형과 범위 식별
- 메시지 초안 작성
- 확인: 제목 ≤ 72자, 명령형 어조, 명확하지 않은 경우 이유 설명
예시
기능: feat(auth): JWT 토큰 갱신 엔드포인트 추가
긴 세션 중 사용자가 로그아웃되지 않도록 방지
버그 수정: fix(reports): 시간대 변환 시 날짜 형식 수정
타임스탬프가 UTC 대신 로컬 시간으로 표시됨
문서: docs: README에 설치 지침 추가