좋은 커밋 메시지 작성법

예전에 읽었던 글이었지만 주로 사용하는 커밋 메시지 이외엔 잘 적용하진 않는 것 같아 정리를 해두려고 합니다.

좋은 커밋의 목적은?

1. 더 좋은 커밋 로그 가독성.
2. 더 나은 협업과 리뷰 프로세스.
3. 더 쉬운 코드 유지보수.

좋은 커밋을 위한 8가지 약속.

1. 제목과 본문을 한 줄 띄워 분리하기
2. 제목은 영문 기준 50자 이내로 작성
3. 제목 첫글자를 대문자로 작성
4. 제목 끝에 . 금지
5. 제목은 명령조로
6. Github - 제목(이나 본문)에 이슈 번호 붙이기
7. 본문은 영문 기준 72자마다 줄 바꾸기
8. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

커밋 템플릿 만드는 방법

$ touch ~/.gitmessage.txt
$ vi ~/.gitmessage.txt

입력 후 저장합니다.

# --- 제목(title) - 50자 이내로 ---
# <타입(type)> <제목(title)>
# 예시(ex) : Docs(Add) Commit docs Add
# --- 본문(content) - 72자마다 줄바꾸기  ---
# 예시(ex) :
# - Workflow
# 1. 커밋 메시지에 대한 문서 제작 추가.
# 2. commit message docs add.
# --- 꼬리말(footer) ---
# <타입(type)> <이슈 번호(issue number)>
# 예시(ex) : Fix #122
# --- COMMIT END ---
# <타입> 리스트
#   init    : 초기화
#   add     : 기능 추가
#   update  : 기능 보완 (업그레이드)
#   fix     : 버그 수정
#   refactor: 리팩토링
#   style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs    : 문서 (문서 추가(Add), 수정, 삭제)
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 변경사항 (빌드 스크립트 수정 등)
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러 줄의 메시지를 작성할 땐 "-" 혹은 "번호"로 구분
# ------------------

 

커밋 템플릿에 적용합니다.

$ git config --global commit.template ~/.gitmessage.txt

 

참고 링크

좋은 git 커밋 메시지를 작성하기 위한 8가지 약속