git 커밋 메세지 템플릿 파일 만들기

커밋 템플릿 파일 만들기(commit template file)

• 커밋 메세지 템플릿을 적용할 git 프로젝트에 진입한 다음, .gitmessage.txt 파일을 생성합니다.
• 이제 그 파일 내용을 아래와 같이 수정합니다.

# <타입> : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성

################
# 본문(추가 설명)을 아랫줄에 작성

################
# 꼬릿말(footer)을 아랫줄에 작성 (관련된 이슈 번호 등 추가)

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

 

# 으로 된 줄은 모두 주석처리된 곳이며, 비어 있는 첫 번째~세 번째 줄에 각각 작성하면 그것이 커밋 제목, 본문, 꼬릿말이 되는 것입니다. 위와 같이 파일 내용을 수정하고 저장합니다.

• 다음 아래 명령어를 입력합니다. <.gitmessage.txt 경로> 부분에는 위에서 생성한 파일의 경로를 입력하면 됩니다. (< > 제외)

git config --global commit.template <.gitmessage.txt 경로>

 

이제부터 git commit 입력 시, 위에서 지정한 템플릿 파일이 자동으로 뜨게 됩니다. 거기에서 커밋 제목, 본문, 꼬릿말 등을 추가하면 됩니다.

이 때 터미널 환경에서 git commit을 입력하면 vi 에디터 환경으로 나올 것입니다. 작성할 때에는 키보드 i 키를 누르면 되며, 작성 완료하고 저장하려면 esc 키를 누른 다음 :wq! 를 입력하고 엔터를 누르시면 됩니다.

 

 

출처 : https://chanhuiseok.github.io/posts/git-4/

[GitHub] git commit 템플릿 사용하여 commit message convention 준수하기