2021. 12. 14. 16:35 개발툴/git
git commit 메시지 템플릿 설정하기
커밋시 git은 commit.template 옵션에 설정한 템플릿 파일을 보여줌
템플릿을 지정하면 커밋 메시지 작성시 일정한 스타일을 유지할 수 있음
1 템플릿 파일 생성
- .git 이 있는 현재 폴더 위치에 .gitmessage.txt 파일을 생성
2 템플릿 파일 작성
- # 로 시작하는 부분은 주석으로 커밋에는 반영되지 않음
################
# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) feat : 로그인 기능 추가
# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 예) Close #7
################
# feat : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refact : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
################
3 템플릿 설정
- git commit 명령 실행시 템플릿 사용
- git config --global commit.template .gitmessage.txt
'개발툴 > git' 카테고리의 다른 글
git commit message 컨벤션 (0) | 2021.12.14 |
---|