Commit message template 설정하기

일관성 있는 commit message convention 을 적용하기 위해 commit message template 을 사용해보자 

(커밋 메세지 작성 규칙에 대해서는 다른 포스트를 작성하기로 하고 여기서는 template 설정법만 작성)

commit message convention 적용의 이점 
1. 더 좋은 커밋 로그 가독성 
2. 더 나은 협업과 리뷰 프로세스 
3. 더 쉬운 코드 유지보수

0. (optional) git commit message editor 변경 

$ git config --global core.editor "editor name(ex. nano)" 

1. commit message template 파일 생성 

 - 텍스트 파일에 아래의 내용을 작성하고 저장한다. 

################
# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) feat : 로그인 기능 추가

# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)

################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)

################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 예) Close #7

################
# feat : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refact : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
################

2. 템플릿 적용 

- git commit.template 에 템플릿 파일을 등록하면 템플릿 파일이 설정되어 git commit 명령을 실행할 때 편집기에서 템플릿 메시지를 자동으로 불러온다. 

$ git config --global commit.template .commitTemplate.txt 

- 이 때 global 옵션은 선택사항 

 

소스코드를 편집하고 git commit 을 하면 자동으로 템플릿을 불러오는 것을 확인할 수 있다. 

 

참고 

https://meetup.toast.com/posts/106

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속 : NHN Cloud Meetup

https://velog.io/@bky373/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%ED%85%9C%ED%94%8C%EB%A6%BF

[Git] 커밋 메시지 템플릿 설정하기