개발/일반

git commit message template 만들기

njsung 2021. 11. 8. 13:09
반응형

git bash를 통해 git commit 메시지를 입력하면, commit message를 수정할 수 있는 폼을 띄울 수 있다.

 

이 때 기본적으로 보여질 템플릿 메시지를 다음과 같은 명령어로 지정할 수 있다.

 

1. gitmessage template파일 저장하기(파일 이름 : .gitmessage.txt)

#   [커밋 타입]  리스트
#   feat      : 기능 (새로운 기능)
#   fix       : 버그 (버그 수정)
#   refactor  : 리팩토링
#   style     : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs      : 문서 (문서 추가, 수정, 삭제)
#   test      : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore     : 기타 변경사항 (빌드 스크립트 수정 등)

# example1
# [feat] AAA 기능 업데이트
#
# AA함수에서 발생하는 오류를 수정하기위해 기능을 AAA로 바꿈

# example2
# [fix] AA 버그 수정
#
# AA함수에서 발생하는 오류를 수정함

2. git config 변경하기

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

3. git commit 명령어로 템플릿 메시지 띄우기

이 때, vscode를 사용하시는 분이라면 다음 명령어로 vscode를 자동으로 띄우게 변경해서 사용하면 편리함

git config --global core.editor "code --wait"

위 명령어로 세팅하면, bash에서 git commit을 입력하면 code가 자동으로 열리고 EDITMSG 파일을 수정한 뒤 파일을 닫으면 자동으로 커밋이 완료된다.

반응형