✅ 커밋 메시지 작성 시 지켜야 할 7가지 규칙
- 제목과 본문을 빈 행으로 구분한다.
- 제목은 50글자 이내로 제한한다.
- 제목의 첫 글자는 대문자로 작성한다.
- 제목 끝에는 마침표를 넣지 않는다.
- 제목은 명령문으로 사용하며 과거형을 사용하지 않는다.
- 본문의 각 행은 72글자 내로 제한한다.
- 어떻게 보다는 무엇과 왜를 설명한다.
📌 대표적인 커밋 메시지 타입 예시 (Conventional Commits 스타일)
feat | 새로운 기능 추가 |
fix | 버그 수정 |
docs | 문서 수정 (README 등) |
style | 코드 포맷팅, 세미콜론 누락 등 기능에 영향 없는 변경 |
refactor | 코드 리팩토링 (기능 변경 없음) |
test | 테스트 코드 추가 또는 수정 |
chore | 빌드 업무, 패키지 매니저 설정 등 기타 작업 |
perf | 성능 개선 |
ci | CI 관련 설정 변경 |
build | 빌드 시스템 또는 외부 의존성 수정 (예: webpack, gradle 등) |
revert | 이전 커밋 되돌리기 |
Initial commit | 프로젝트 생성 후 첫 커밋 |
💡 타입별 커밋 메시지 예시
# feat: 새로운 기능 추가
feat: 사용자 프로필 편집 기능 추가
feat: 게시글 좋아요 기능 구현
# fix: 버그 수정
fix: 로그인 실패 시 오류 메시지가 출력되지 않는 문제 수정
fix: 모바일 화면에서 버튼 클릭 안 되는 문제 해결
# docs: 문서 수정
docs: README에 프로젝트 실행 방법 추가
docs: API 명세서 최신 정보로 갱신
# style: 코드 포맷 등 기능에 영향 없는 변경
style: 코드 정렬 및 세미콜론 정리
style: Lint 오류 수정
# refactor: 리팩토링 (기능 변경 없음)
refactor: 중복된 유틸 함수 정리
refactor: 컴포넌트 구조 개선
# test: 테스트 코드 추가 및 수정
test: 로그인 기능 단위 테스트 추가
test: 사용자 정보 API 테스트 케이스 보완
# chore: 기타 변경사항 (빌드 설정, 패키지 등)
chore: 설정 파일 수정
chore: 패키지 업데이트 및 의존성 정리
# perf: 성능 개선
perf: 이미지 로딩 최적화
perf: 리스트 렌더링 속도 개선
# ci: CI 관련 설정 변경
ci: GitHub Actions 배포 스크립트 수정
ci: 테스트 자동화 워크플로우 추가
# build: 빌드 시스템 변경
build: Production 환경용 webpack 설정 추가
build: 빌드 스크립트 수정
# revert: 이전 커밋 되돌리기
revert: 'feat: 게시글 삭제 기능 추가' 커밋 되돌림
# Initial commit: 프로젝트 생성 후 첫 커밋
Initial commit
✏️ 작성 예시
fix: API 응답값에서 null 처리 누락 문제 수정
특정 사용자 정보 요청 시 응답 데이터의 일부 필드가 null일 경우,
프론트엔드에서 렌더링 오류가 발생하던 문제를 해결
resolves: #1125
Ref: 좋은 git commit 메시지를 위한 영어 사전
'Git & GitHub' 카테고리의 다른 글
원격의 Branch 다루기 (1) | 2023.01.26 |
---|---|
Push와 Pull (0) | 2022.11.30 |
원격 저장소 사용하기 (0) | 2022.11.29 |
GitHub 시작하기 (0) | 2022.11.29 |
Git 원격 저장소 (0) | 2022.11.29 |
댓글