Git Commit template 설정 | 깃 커밋 템플릿 설정

jung_ho9 개발일지·2023년 5월 12일
0

Github | Git

목록 보기
10/10
post-thumbnail
post-custom-banner

1. 템플릿 파일 생성

아래 명령어를 통해 최상위 폴더에 gitmessage.txt 파일을 생성한다.

touch .gitmessage.txt

2. 템플릿 파일 작성

gitmessage.txt 파일 자체에 아래 내용을 복사하여 붙여넣거나, vim 과 같은 편집기를 사용해 작성한다.

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

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

################
# 본문(구체적인 내용)을 아랫줄에 작성


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


################
# --- COMMIT END ---  
#   <타입> 리스트  
#   feat        : 기능 (새로운 기능)  
#   fix         : 버그 (버그 수정)  
#   refactor    : 리팩토링  
#   design      : CSS 등 사용자 UI 디자인 변경  
#   comment     : 필요한 주석 추가 및 변경  
#   style       : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)  
#   docs        : 문서 수정 (문서 추가, 수정, 삭제, README)  
#   test        : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)  
#   chore       : 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등)  
#   init        : 초기 생성  
#   rename      : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 한 경우  
#   remove      : 파일을 삭제하는 작업만 수행한 경우  
# ------------------  
#   제목 첫 글자를 대문자로  
#   제목은 명령문으로  
#   제목 끝에 마침표(.) 금지  
#   제목과 본문을 한 줄 띄워 분리하기  
#   본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.  
#   본문에 여러줄의 메시지를 작성할 땐 "-"로 구분  
# ------------------  
#   <꼬리말>  
#   필수가 아닌 optioanl  
#   Fixes        :이슈 수정중 (아직 해결되지 않은 경우)  
#   Resolves     : 이슈 해결했을 때 사용  
#   Ref          : 참고할 이슈가 있을 때 사용  
#   Related to   : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)  
#   ex) Fixes: #47 Related to: #32, #21  

# 으로 시작하는 줄은 모두 주석처리가 되니 신경쓰지 않아도 된다.
위와 같이 템플릿 내용을 수정하고 저장한다.

3. 명령어 지정

아래 명령어를 통해 git commit 입력 시, 지정한 템플릿이 출력된다.

git config --global commit.template <.gitmessage.txt 경로>
profile
꾸준하게 기록하기
post-custom-banner

0개의 댓글