- Published on
Git 커밋 메시지 잘 쓰는 법
- Authors
- Name
- Hyo814
Git 커밋 메시지 잘 쓰는 법
커밋 메시지는 코드 변경의 의미와 이유를 기록하는 짧은 설명입니다. 잘 작성된 커밋 메시지는 코드 리뷰, 히스토리 파악, 장애 대응 시 원인 추적을 훨씬 쉽게 만들어줍니다.
기본 형식
<type>(<scope>): <subject>
<body>
<footer>
| 구성 | 필수 여부 | 설명 |
|---|---|---|
type | 필수 | 커밋 종류 |
scope | 선택 | 변경 범위 (파일, 모듈 등) |
subject | 필수 | 변경 요약 (50자 이내) |
body | 선택 | 변경 이유 및 상세 내역 (72자 이내/행) |
footer | 선택 | 이슈 번호, 참고사항 |
커밋 타입 종류
| 타입 | 사용 상황 |
|---|---|
feat | 새로운 기능 추가 |
fix | 버그 수정 |
docs | 문서 변경 |
style | 코드 포맷, 세미콜론 등 (로직 변경 없음) |
refactor | 리팩터링 (기능 변화 없음) |
test | 테스트 코드 추가/수정 |
chore | 빌드, 설정 등 기타 작업 |
작성 규칙
- 제목과 본문은 빈 줄로 구분한다
- 제목은 50글자 이하, 본문 각 행은 72글자 이하
- 제목 첫 글자는 대문자, 끝에 마침표 없음
- 과거형 대신 명령문·현재형 사용 (
"Change"O,"Changed"X) - 변경의 범위, 핵심, 이유 중심으로 작성
예시
기능 추가
feat: 회원가입 이메일 인증 기능 추가
- 인증 코드 전송 및 검증 로직 구현
- 인증 실패 시 에러 메시지 표출
Resolves: #101
버그 수정
fix(login): 로그인 실패 시 에러 처리 강화
- 서버 응답값 검사 로직 추가
- UX 개선을 위해 에러 메시지 직관적으로 변경
관련: #304
리팩터링
refactor(api): 중복된 인증 미들웨어 통합
인증 로직이 각 뷰마다 흩어져 있어
공통 데코레이터로 분리하여 중복 제거
나쁜 예 vs 좋은 예
| 나쁜 예 | 좋은 예 |
|---|---|
수정함 | fix: 로그인 토큰 만료 오류 수정 |
작업 중 | feat(auth): 소셜 로그인 카카오 연동 추가 |
여러 가지 변경 | 커밋을 기능 단위로 분리 |
fix bug | fix(cart): 장바구니 수량 0 이하 입력 허용 오류 수정 |
한 줄 요약
왜 변경했는지, 무엇을 변경했는지를 50자 안에 담아라. 본문이 필요하다면 이유와 배경을 추가하고, 이슈 번호로 컨텍스트를 연결하라.
작은 변경도 메시지로 남기는 습관이 쌓이면 팀 전체의 코드베이스 이해도가 올라갑니다.