Git commit 템플릿 만들기

📚 템플릿으로 commit 쉽게하기

 

git에서 commit을 잘 하는 것은 중요하다.

1. 버전 관리    모든 변경 사랑을 효율적으로 추적 및 관리 
2. 협업 : 다른 개발자가 새로운 변경 사항을 쉽게 이해하도록 도움
3. 추적 : commit이 왜 행해졌는지 확인
4. 되돌리기와 병합 : 변경 사항을 적용하거나 되돌리기 가능 
5. 충동 해결 : 충돌 발생 시 commit 기반으로 충돌 해결
6. 테스트와 배포 : 테스트나 배포를 할 때 특정 commit 기반으로 작업 가능 

 

이러한 이유들 때문에 commit은 중요하고, 또 잘 써줘야 한다. 

 

commit 문구를 일관성 있게 해줘야하는데, 

매번 하나하나 찾아 문구 쓰는것은 귀찮다. 

 

하지만 템플릿을 통해 문구를 작성하면

훨씬 쉽게  이쁜 커밋 문구를 작성할 수 있다.

 

---

📗 메모장에 템플릿 만들기

먼저 touch .gitmessage.txt 명령어를 통해 gitmessage.txt 파일을 만들어준다 .

(터미널에서는 코드 작동이 안돼서 git bash에서 작성)

 

txt 파일 수정을 위해 vim gitmessage.txt 명령어로 vim 모드로 들어간다.

 

### 제목
# 커밋 타입: 작업내용 (제목과 본문은 한 줄 띄워주세요)


### 본문 - 한 줄에 최대 72 글자까지만 입력하기  
# 무엇을, 왜, 어떻게 했는지


# 꼬리말
# (선택) 이슈번호 작성

#   [커밋 타입]  리스트
#   feat      : 기능 (새로운 기능)
#   fix       : 버그 (버그 수정)
#   design    : CSS 등 사용자 UI 디자인 변경
#   refactor  : 리팩토링
#   style     : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs      : 문서 (문서 추가, 수정, 삭제)
#   test      : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore     : 기타 변경사항 (빌드 스크립트 수정 등)
#   post      : 블로그 포스트 추가 (신규 포스트 작성 및 수정)
#   rename    : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 하는 경우
#   remove    : 파일을 삭제하는 작업만 수행한 경우
# ------------------
#   [체크리스트]
#     제목 첫 글자는 대문자로 작성했나요?
#     제목은 명령문으로 작성했나요?
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분했나요?

 

vim 수정  :  esc - a 
vim 종료  :  esc - (shift + z) * 2

 

esc 누르고  a  단축키로 vim의 수정모드로 들어가고, 

해당 메시지를 복사 붙여넣기 한다. 

 

그리고 esc 누르고  shift +z 를 두번 누르면 vim 모드가 종료된다.

(그냥 메모장에 붙여넣기 해도 된다.)

 

 

📗 commit 템플릿 설정

git config --global commit.template gitmessage.txt 명령어로

gitmessage.txt를 commit의 템플릿으로 지정한다.

 

 

 

 

git add . 를 통해 변경 사항을 스테이지에 올린 후

git commit을 하면 해당 템플릿이 뜬다.

 

이제 템플릿에 맞춰 commit 문구를 작성해주면 된다.

vim 수정  : esc - a 
vim 종료  : esc - (shift + z) * 2

 

터미널로 commit을 할 경우

EDITMSG 종료  :   !wq
EDITMSG 저장 없이 종료  :    :!q

 

그리고 원격 저장소에서 확인을 위해 git push 를 해주자 

 

 

깃 허브에 commit을 확인하니 잘 쓰여진 것을 확인 할 수 있다.

이로써 좀 더 일관되고 정돈된 commit 문구를 작성 할 수 있게 되었다. 

 

 

📕 commit 템플릿 지우기

commit 템플릿이 필요없어서 지우려는 경우

 

git config --list 는 현재 나의 git 설정을 확인 할 수 있다. 

commit.template 쪽을 보면 gitmessage.txt가 잘 설정 되어있는 것을 확인 할 수 있다.

 

 

 

만일 삭제를 원한다면 ,

git config --global --unset commit.template 명령어를 작성해주면 된다.

( git config --list 을 확인해보면 commit.template 부분 사라진 것 확인 가능 )