[GIT] git commit message template

doppelgoer
|2024. 2. 1. 23:56

 

텍스트 파일 생성

 .gitmessage.txt 파일을 프로젝트 최상위에 만들어 준다.

 

텍스트 파일 내용

# 으로 시작하는 줄은 주석처리되어서 commit message 에 적용되지 않는다.

################
# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) feat : 로그인 기능 추가

# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)

################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)

################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 예) Close #7

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

자주 쓰이는 commit message 템플릿이며, 텍스트 파일이니 프로젝트에 맞춰서 수정하면 된다.

 

템플릿 적용

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

를 입력하면 된다.

아래처럼 issue template 도 만들어서 commit template 와 알맞게 적용 가능하다.

 

 

개인 기록용입니다. 만약 잘못된 부분이 있다면 댓글로 알려주신다면 감사하겠습니다!