git commit message를 잘 쓰고 싶다.

뜬금없지만 "죽을 때까지 코딩하며 사는 법"라는 책을 읽고 있다.
거기에서 좋은 코드에 대해 이야기가 나오고 나를 좀 되돌아보게 되었다.
바쁘다, 귀찮다, 어차피 혼자하는데 등등 여러가지 핑계를 대면서 나 자신도 모르게 미루고 있었다.
그러다 git commit message에 대해서 되돌아보게 되었고

나도 git commit message를 잘 쓰고 싶었다.

그러면 도대체 git commit message는 어떻게 하면 잘 쓸 수 있을까??

좋은 git commit message 을 구글링을 하면서 여러 블로그 포스트를 보았고.

해당 내용을 기록하기로 했다. 

나는 어떻게 쓰고 있었는가?

private project로 나홀로 작업하고 있었던 commit message 를 일부 캡처했다.
혼자해서 그런지 매우 간략하게 이런거했어요 라고 적었을뿐 시간이 지나서 보면 도대체 머지하는 생각이 들게 하는 메시지다.
그래서 커밋메시지로 무엇을 작업했는지 나뿐만 아니라 다른 사람이 봐도 이해할 수 있게 해야한다는게 핵심이다.

본문을 보기 전에
좋은 git 커밋 메시지를 작성하기 위한 8가지 약속
이 글에 있는 내용을 먼저 읽으면 좋다.
좋은 커밋을 하는 이유는 무엇인지 좋은 커밋 메시지를 작성하기 위한 8가지 약속은 무엇인지를 잘 정리해주셨다!

git commit message를 잘 쓰려고 노력해야 하는 이유

1. 더 좋은 커밋 로그 가독성
2. 더 나은 협업과 리뷰 프로세스
3. 더 쉬운 코드 유지보수
   그렇다면 좋은 커밋 메시지는 무엇일까?
   사람마다 생각하는 것도 다 다르기 때문에 정답은 없지만,
   좋은 코드를 작성하기 위한 약속, 설계를 잘 하기 위한 약속이 있는 것 처럼,
   좋은 커밋 메시지를 작성하기 위한 약속(표준)은 아래와 같다.

좋은 git commit message를 작성하기 위한 8가지 약속

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

아직 익숙하지 않지만 모닥불 개발자가 목표이니까! 조금씩 꾸준히 해서 익숙해져보자!

git commit.template

커밋 메시지 내용을 작성할 때 마다 기준을 가져와서 정의할 수 없으니 사용자 지정 커밋 템플릿으로 커밋 메시지를 작성할 때 마다 일정한 스타일을 유지할 수 있다.

git commit.template 설정해보기

1. ~/.gitmessage.txt 파일을 아래와 같이 만든다
   좋은-git-commit-메시지-작성하기에 있는 . Git 템플릿 만들기을 참고하여 커스텀 템플릿를 만들었다.

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

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

commit.template 에 설정하면 Git은 git commit 명령이 실행하는 편집기에 이 메시지를 기본으로 넣어준다.
그러면 커밋할 때 아래와 같은 메시지를 편집기에 자동으로 채워준다.
vscode를 킨 상태로 설정했다면 vscode를 다시 실행해야 적용이 된다!

잘 설정되었다면 위의 이미지처럼 적용이 된다!
그렇다면 앞으로 함 잘 해보자! 아자아자

참고자료

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

좋은-git-commit-메시지-작성하기