[Git] 템플릿을 적용하여 Commit 하기

Git message에 대해 학습 후 정리한 포스팅 입니다.

 

이번 포스팅에서는 템플릿을 적용하여 Commit 하는 방법에 대해 학습합니다.

 

 

I) Commit Message 템플릿 설정?

Git 커밋 메시지 템플릿을 설정하여 커밋을 할 수 있습니다.

템플릿을 설정하여 커밋을 하면 팀 전체에 일관적으로 커밋 메시지를 설정할 수 있습니다.

(일관성, 명확성, 문서화, 협업, 코드 리뷰 등에서 장점!)

 

 

II) Commit Message 템플릿 설정 방법 

1. 템플릿 파일 작성

.gitmessage.txt 파일을 만들어 아래와 같은 커밋 메시지 템플릿 내용을 작성합니다.

# ------- COMMIT END -------
# <타입> 리스트
#    Feat      :  새로운 기능 추가
#    Fix       :  버그 수정
#    Docs      :  문서 수정
#    Style     :  코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
#    Refactor  :  코드 리팩토링
#    Test      :  테스트 코드, 리팩토링 테스트 코드 추가
#    Chore     :  패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
#    Comment   :  필요한 주석 추가 및 변경
#    Rename    :  파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
#    Remove    :  파일을 삭제하는 작업만 수행한 경우
#    !HOTFIX   :  급하게 치명적인 버그를 고쳐야 하는 경우
# --------------------------

커밋 시 타입에 해당하는 부분의 주석을 해제한 후 작성하면 됩니다.

 

2) 템플릿 파일 설정

git commit 시 템플릿을 불러올 수 있게 템플릿 파일을 설정합니다.

git config --global commit.template ".gitmessage.txt 경로"

3) Commit Message 작성 

# 파일 스테이지 업로드
git add [파일]

# 커밋 메시지 작성하기
git commit

# 해당하는 타입에 주석을 지우고 내용 적기
# ------- COMMIT END -------
# <타입> 리스트
    Feat      :  보고서 자동화 기능 추가
#    Fix       :  버그 수정
#    Docs      :  문서 수정
#    Style     :  코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
#    Refactor  :  코드 리팩토링
#    Test      :  테스트 코드, 리팩토링 테스트 코드 추가
#    Chore     :  패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
#    Comment   :  필요한 주석 추가 및 변경
#    Rename    :  파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
#    Remove    :  파일을 삭제하는 작업만 수행한 경우
#    !HOTFIX   :  급하게 치명적인 버그를 고쳐야 하는 경우
# --------------------------

# 작성 후 쓰고, 저장
:wq

# 푸쉬
git push origin main

 

git commit -m 이 아니라 git commit임에 주의합니다.

 

 

 

ref: 

Git - 커밋 메시지 컨벤션

[Git] 커밋 메시지 템플릿 설정하기

 

 

 

 

 

<Summary>

- 템플릿을 적용하여 Commit 하기

 

*유의사항

- AI 산업기능요원이 공부하여 남긴 정리입니다.