[Git] 커밋 메시지 템플릿 설정하는 방법

💡 git commit template
     : commit 시에 등록된 commit template을 보여줌으로써
       commit message를 일정한 규칙에 맞게 작성할 수 있도록 도와줌

    

[git commit template 등록하기]

1. git 폴더가 있는 위치에 .gitmessage.txt 파일을 생성

필자의 경우 프로젝트 최상단에 위치하였다.

 

2. 생성한 .gitmessage.txt 에 내용을 작성

• # 으로 시작하면 주석 처리되어 커밋에 보이지 않습니다.
• 다음 사이트를 참고하여 본인에 맞게 룰을 작성하면 됩니다.

https://meetup.nhncloud.com/posts/106

 

 

[Type] title (#이슈번호)
# [Header]
# 형식 - [Type] title (#이슈번호)
#
# [Type] 입력 목록
#  1. Feat: 새로운 기능 추가
#  2. Fix: 오류 해결
#  3. Rename: 파일 혹은 폴더명을 수정만 한 경우
#  4. Remove: 파일을 삭제만 한 경우
#  5. Style: 기능 수정 없이 코드 스타일만 변경한 경우 (코드 포매팅, 세미콜론 누락 등)
#  6. Design: 사용자 UI 디자인 변경 (CSS 등)
#  7. Refactor: 코드 베이스의 특정 부분을 재정렬 (Refactoring)
#  8. Test: 테스트와 관련된 모든 것
#  9. Docs: 문서화에 관한 모든 것
#  10. Chore: 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
#  11. Perf: 성능 개선
#
# [Title] 규칙
#  1. 50자 이내 짧은 요약 (영어의 경우 첫글자는 대문자로)
#  2. 명령형으로 작성 (과거형X)
#  3. 제목 끝에 .(마침표) 금지
#
# [Body] 작성 규칙
#  1. 제목과 본문 사이 빈 칸 한줄 필수 (제목과 본문 분리)
#  2. 생략 가능, 필요 시 자세한 설명 작성 (72자 내외로 마무리)
#  3. 적용한 변경사항과 그것을 만든 이유에 대해 설명
#     - 어떻게보다는 "무엇을", "왜"

 

 

> commit message template 설정하기

터미널 창에 아래 명령어를 입력하면 설정이 완료된다.

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

 

이제 커밋을 할 때마다 커밋 메시지 작성 란에 template이 자동으로 보여지고 참고하여 메시지를 작성하면 된다!

 

참고 블로그

• 좋은 git 커밋 메시지를 작성하기 위한 7가지 약속
• Writing Meaningful Git Commit Messages
• Conventional Commits 1.0.0

• https://coyo-hm.github.io/post/git-commit-template