git 커밋 메시지 템플릿 작성, 설정

깃 커밋(git commit) 시, 커밋 메시지(commit message)를 작성할 때 템플릿을 만들 수 있습니다.

여러 명이 협업으로 프로젝트의 버전 관리를 git으로 하는 개발 환경에서 꽤 유용합니다.

서로 규칙을 지키면 가독성도 좋고 프로젝트 수행에서 버전 관리를 더 원활할 것이 기대되기 때문입니다.

 

방법은 다음 3단계로 작성이 가능합니다.

 

운영체제상의 루트 디렉토리에 .gitmessage 파일을 만들어야 합니다. 이 파일 자체가 커밋 템플릿이 됩니다.

향후 커밋할때마다 콘솔에 작성된 메시지가 출력됩니다.

 

1. git message 파일 생성 및 작성

 

.gitmessage 파일 생성한다.

$touch .gitmessage

 

vim editor나 다른 editor에서 템플릿을 작성합니다.

 

$vim ~/.gitmessage

 

다음 예제의 type과 model처럼 필드를 지정해서 해당 메시지를 넣으면 됩니다.

# 누워서 코딩 COMMIT MESSAGE TEMPLATE
# new: 새로운 기능 추가
# bug: 버그 수정
# enh: 새로운 기능의 개선 및 추가 변경
# docs: 문서 추가 수정 삭제
# chore: 기타 변경 사항
# ex)
# bug - wrong parameter
type: <description>
# <models> - A_Project, B_Project, C_Project
model: ALL
#---------------------
# 제목은 최대 50글자까지 작성
# type과 model 이후 콜론은 한칸 띄워 분리하기
# description 마지막에 (.) 금지
#---------------------

 

2. 작성된 git message를 템플릿으로 지정, git editor도 추가 지정

 

• 템플릿 파일을 설정하는 이유는, git commit 명령을 실행할 때마다 이 지정된 템플릿 메시지를 사용하는 편집기상에서 사용할 수 있기 때문이다.
• 다음은 템플릿 파일을 설정하기 위한 명령 예제이다.

$git config --global commit.template .gitmessage editor

• commit.templte에 .gitmessage 파일을 등록한다는 의미이다. 추가로 git editor도 지정합니다. vim을 지정하고자 하면 아래 "editor" 부분을 "vim"으로 변경합니다.

3. 커밋 메시지 작성하기

상기 1,2로 템플릿 설정까지 마친 상태에서의 커밋 메시지 작성하는 방법입니다.

 

• git add [파일명] 명령을 실행합니다.
• 다음으로 git commit을 실행하면, 작성된 커밋 메시지가 editor창에 출력됩니다.
• 작성된 커밋 메시지의 문법대로 type과 model과 같은 필드에 해당 변경 사항들을 작성합니다.
• 작성이 끝나면 git push 명령으로 해당 커밋을 원격 저장소에 올립니다.

 

이후 추가적인 규칙을 변경 및 추가하고 싶을 때는 이 .gitmessage를 열어 변경하면 됩니다.

내가 아닌 잘 모르는 누군가도 쉽게 작성하고 보기 편하게 최대한 간결하고 명료하게 작성하는 것이 중요합니다.

 

다음은 일반적으로 사용되는 커밋 메시지 작성 규칙 예제이니 참고하세요.

 

커밋 유형(Commit Type) 지정 예

• NEW: 새로운 기능 추가
• FIX: 버그 수정
• DOCS: 문서 수정
• STYLE: 스타일 관련 수정(코드 포맷, 코드 변경 없는 경우, 세미콜론 Null 누락 등)
• CHORE: 실제 기능과 무관한 빌드, 패키지 관련 수정 (ex. .gitcommit 파일 수정)
• TEST: 테스트 관련 코드 추가

제목의 행은 50자 내로 제한

• 읽기 쉬운 가독성을 위해 규칙을 정한다.

 

제목이나 본문 행의 첫 글자는 대문자로 시작하기

 

제목 행의 끝에 마침표를 넣지 않기

 

제목 행은 가급적이면 명령문으로 작성한다

ex) Remove the file description

     Add the new feature

 

본문(Description) 설명은 How(어떻게) 보다는 Why(왜)나 What(무엇)으로 설명한다.

 

팀원들이 합의하에 정한 커밋 규칙은 되도록 따르도록 하자