Git커밋메시지템플릿초보환영
좋은 커밋 메시지 작성 규칙과 예시
변수 입력4개
언제 사용하나
나중에 이력을 읽는 사람(미래의 나 포함)이 변경 의도를 이해하게 하려 할 때.
실행 전 확인
- 이 커밋이 "무엇을 왜" 바꾸는지 한 줄로 말할 수 있는지 확인한다.
규칙과 템플릿
{{type}}: {{요약 - 명령형, 50자 내외}}
{{본문 - 왜 이 변경이 필요한지, 무엇을 바꿨는지 (선택)}}
{{꼬리말 - 관련 이슈 (예: Refs #123) (선택)}}type예: feat, fix, docs, refactor, test, chore- 제목은 마침표 없이, 명령형("추가한다"가 아니라 "추가")
- 본문은 "어떻게"보다 "왜"에 집중
placeholder 설명
{{type}}: 변경 종류{{요약}}/{{본문}}/{{꼬리말}}: 각 구성
입력 예시
fix: 로그인 실패 시 500 대신 401 반환
토큰 검증 실패를 인증 오류로 처리하도록 수정.
Refs #240기대 결과
검색·되돌리기·리뷰가 쉬운 일관된 커밋 이력.
검증 방법
git log --oneline만 읽어도 변경 흐름이 이해되는지 확인한다.
주의사항과 흔한 실수
- "수정", "작업" 같은 모호한 메시지는 피한다.
- 여러 목적을 한 커밋에 담지 않는다.
관련 문서
댓글 0개
아직 댓글이 없습니다.