Git Commit Template 설정

2022-07-22 github.io에서 작성

Git을 사용하다 보면 commit 작성할 일이 빈번하고, 항상 일정한 양식이 있었다는 생각을 합니다.

기존에 Sourcetree를 사용하다보니 commit template가 적용되지 않아 불편함을 안고 사용했었는데 이번에 gitkraken으로 교체하면서 template 사용법을 정리하고자 합니다.

Setting commit template

대부분의 git 프로그램은, commit message를 작성 할 때, commit.template 옵션에 설정한 템플릿 파일을 보여줍니다.

.gitmessage.txt를 생성하고 내부 템플릿을 작성 한 뒤, 파일 경로 설정을 통해 항상 사용하도록 적용 해 둡니다.

git config --global commit.template .gitmessage.txt

주석 mark 변경

기본적으로 git에서 사용 하고 있는 주석 mark는 #입니다.
그런데 실제로, #마크를 commit message에 사용해야만 하는 경우에는 주석 mark를 변경해야만 합니다.

#를 대신해서 ;로 바꾸었습니다.

git config --global core.commentChar ";"

.gitmessage.txt

[#] title
;[#IssueNumber] Commit Title

; title과 본문 사이에 Blank Line을 두어 구분합니다.
; template에 설정된 각 제목은 예시입니다.
; 변경하여 자유롭게 사용해 주세요.
; Markdown을 이용하여 작성합니다.
## 작업 배경
*
*
## 수정 내용
*
*
## 참고
*

; 아래 키워드를 본문에 적어 키워드를 이용해 Issue를 종료하셔도 됩니다.
; close, closes, closed
; fix, fixes, fixed
; resolve, resolves, resolved