Git Commit Template 설정

🤔 Git Commit Template 란?

- commit 작성법을 규칙으로 정하고 그 규칙을 가이드할 수 있는 파일.

 

 

 

 

📋 템플릿 만들어보기

아래 템플릿 작성방법은 💻 MAC 기준입니다.

 

 

1. 프로젝트 최상위 경로에 템플릿 파일을 생성

- 터미널을 진입 후 명령어로 파일 생성. 이때 파일 이름은 정해진 규칙 없이 자유롭게 작성하면 된다.

- touch : 파일 생성

- {.gitmessage.txt} : 앞에 붙은 온점은 숨김 파일을 뜻한다. 텍스트 파일로 만들 거기 때문에 확장자는. txt를 붙여준다.

touch .gitmessage.txt

 

2. 텍스트 에디터로 파일을 실행해 편집 (vim사용)

vim .gitmessage.txt

 

3. 커밋 메시지 템플릿 작성

- # 으로 시작하는 줄은 주석 처리된다.

##### 제목 - 50자 이내로 작성
# [제목은 이곳에 작성]
##### 본문 - 긴 설명이 필요한 경우에 작성
# [본문은 이곳에 작성]
# 1. 본문 내용은 양에 구애받지 않고 최대한 상세히 작성
# 2. 무엇을 수정했는지
# 3. 왜 수정했는지
##### 꼬리말 - 이슈가 존재할 시 작성
# [꼬리말은 이곳에 작성]
# 1. [#issueNumber]
# 2. 종료 키워드
#    - close / closes / closed 
#    - fix / fixes / fixed
#    - resolve / resolves / resolved

# -------------------
#   [ 커밋 타입 ] 리스트
#   feat     : 기능 (새로운 기능)
#   fix      : 버그 (버그 수정)
#   design   : CSS 등 사용자 UI 디자인 변경
#   !HOTFIX  : 급하게 치명적인 버그를 고쳐야하는 경우
#   style    : 코드 포맷 변경, 세미 콜론 누락, 비즈니스 로직에 변경 없음
#   refactor : 기능추가는 없지만 코드 정리 또는 개선
#   comment  : 필요한 주석 추가 및 변경
#   docs     : 문서를 수정한 경우
#   chore    : 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우
#   rename   : 파일을 삭제하는 작업만 수행한 경우
#   revert   : 이전 커밋으로 회귀할 때, 내용 상세히 기재, 꼬릿말 해시값 기재
# -------------------
#   [체크리스트]
#     제목은 소문자
#     과거형으로 작성 금지
#     제목 끝에 마침표(.), 느낌표(!), 물음표(?) 금지
#     최대 50글자가 넘지 않도록 함
# -------------------

- i 를 눌러 편집 모드에 진입한 후 텍스트를 편집한다

- ESC키를 눌러 편집 모드에서 빠져나온 후 :wq 를 눌러 저장해준다

 

 

4. git 설정 저장

- 터미널에 아래 명령어를 입력 ( 이렇게 입력하면 현재 프로젝트만 커밋 템플릿이 설정된다)

git config commit.template .gitmessage.txt

 

- global 설정을 추가해주면 모든 프로젝트에서 템플릿을 사용할 수 있다

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

 

5. 커밋 템플릿 사용법

- 평소 commit -m "커밋 메시지" 이런 식으로 입력했지만 커밋 템플릿을 사용하려면 git commit 만 입력한다

git commit

 

 

수정사항 파일을 add 해준 후 git commit 명령어를 입력하면 앞서 만든 템플릿이 터미널에 나타난다

 

텍스트 에디터 모드이므로 i 를 눌러 입력 상태로 진입한 후

주석 처리해 뒀던 부분을 지우고 커밋 메시지를 입력한다

 

나는 이 부분을 지우고 커밋 메시지를 작성했다

이렇게 작성을 마쳤다면 다시 esc 키를 눌러 편집 모드를 빠져나간 후

아래 명령어를 입력한다

:wq

그러면 자동으로 커밋 메시지 입력이 끝나고 푸시만 해주면 된다 !

git push

 

푸시하고 결과물을 확인해보면

이렇게 제목과 본문, 꼬리말이 잘 들어온 모습을 확인할 수 있다 ㅎㅅㅎ

 

 

생각보다 커밋 메시지 입력하는 과정이 험난하긴 하지만 템플릿을 확인하면서 작성할 수 있으니 좋은 듯하다.

다만 텍스트 에디터 편집 모드가 익숙지 않아서 문제 ^^...