커밋 메시지 컨벤션 정리
버전 관리 시스템(Git)에서의 커밋 메시지는
변경 사항의 목적과 성격을 명확하게 전달하기 위한 중요한 문서입니다.
프로젝트 규모가 커질수록 일관된 커밋 메시지 작성 규칙(컨벤션)은
협업 효율과 변경 이력 관리에 큰 도움이 됩니다.
1. 커밋 메시지 유형 (Prefix)
| 유형 | 설명 |
|---|---|
feat | 새로운 기능 추가 |
fix | 버그 수정 |
BREAKING CHANGE | 호환되지 않는 변경 사항 |
docs | 문서 변경 (README, 주석 등) |
style | 코드 스타일 변경 (공백, 들여쓰기 등) |
refactor | 리팩터링 (기능 변경 없이 코드 구조 개선) |
test | 테스트 코드 추가 및 수정 |
build | 빌드 시스템 변경 (webpack, vite 등) |
ci | CI 설정 변경 (GitHub Actions 등) |
perf | 성능 개선 |
chore | 기타 작업 (버전 업데이트, 패키지 설치 등) |
2. 커밋 메시지 작성 규칙
- 영문 작성 권장
- 첫 글자 대문자, 나머지 소문자
- 문장 끝에 마침표(.) 사용하지 않음
- 명령형 사용 (예:
Add,Fix,Refactor)
# 예시
feat: Add login form validation
fix: Resolve 500 error on user API
docs: Update README with installation guide3. 자주 사용하는 동사 표현
| 동사 | 의미 및 사용 예 |
|---|---|
Add | 새로운 기능, 파일, 코드 추가 (Add: Add login modal) |
Fix | 버그 또는 오류 수정 (Fix: Fix typo in user name) |
Update | 기능 또는 내용 갱신 (Update: Update dependencies) |
Improve | 개선, 품질 향상 (Improve: Improve mobile layout responsiveness) |
Refactor | 기능 변화 없이 코드 구조 변경 (Refactor: Refactor sidebar logic) |
Remove | 코드, 파일 제거 (Remove: Remove unused variable) |
Rename | 이름 변경 (Rename: Rename 'btn' to 'button') |
Optimize | 성능 개선 (Optimize: Optimize image loading) |
Clean | 불필요한 코드 정리 (Clean: Remove console logs) |
Document | 문서화 작업 (Document: Add API usage to README) |
Implement | 기능 구현 (Implement: Implement dark mode toggle) |
Handle | 예외 처리 (Handle: Handle network error gracefully) |
Deploy | 배포 관련 (Deploy: Deploy to Netlify) |
Bump | 버전 증가 (Bump: Bump version to 1.0.3) |
Revert | 커밋 되돌리기 (Revert: Revert "Add login modal") |
4. 참고 링크
5. 예시 이미지
커밋 메시지를 어떻게 구성하고 관리하면 좋은지에 대한 시각적 예시는 아래를 참고하세요:
꾸준히