git commit template 설정하기

commit template을 사용하면 커밋 메시지의 구조와 형식을 일관되게 유지할 수 있습니다. 팀의 구성원들이 동일한 template을 사용하면 commit message가 일관성 있게 작성되어 코드 기록과 변경 내용을 파악하기 쉬워집니다. template을 설정하면 커밋 작성 과정이 자동화되고 개발자는 템플릿에 정의된 섹션에 적절한 내용을 작성하기만 하면 되기 때문에 git commit이 간편해집니다.

1. git commit template 파일 만들기

mkdir ~/git
vim ~/git/.gitmessage

2. ~/git/.gitmessage 파일 작성하기

생성한 파일에 커밋 템플릿을 작성합니다. 

 

# 다음과 같은 형식으로 제목을 작성합니다.
# [type]: 제목
[fea|docs|mis|fix|test|ref]: 제목

# 설명을 입력합니다.
describe:

#=========================
# fea : 새로운 기능 추가
# docs : 문서 수정
# mis : 실수로 빼먹은 내용
# fix : 버그 수정
# test : 테스트 코드
# ref : 코드 리팩토링
#=========================

3. 작성한 파일 적용하기

Git의 commit.template 설정을 업데이트합니다.

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

위 명령어는 ~/git/.gitmessage.txt 파일을 전역 설정으로 사용하도록 Git에 알려줍니다. --global 옵션을 사용하면 현재 사용자의 전역 Git 설정에 영향을 미치게 됩니다. 이제 git commit 명령어를 실행하면 설정한 템플릿이 기본적으로 열리며, 해당 템플릿에 따라 커밋 메시지를 작성할 수 있습니다.