git 공부하기 - 템플릿 설정 및 사용

🤍

 

프로젝트 하면서 깃 사용할 일 정말 많고

효과적이고 깔끔한 커밋을 위하여 템플릿을 설정해보고 사용해는 연습을 ! ✨

더불어 깔끔한 커밋 작성하는 요령까지 공부해보자

---

깃 커밋 템플릿 설정하기

💡
커밋 템플릿은 git 커밋을 할 때 매번 똑같은 형식으로 메시지를 쓰기 쉽게 도와주는 초안 파일로,
commit message를 일정한 규칙에 맞게 작성할 수 있도록 도와줌

 

 

[commit template 등록]

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

 

💭 그냥 루트 디렉토리에 만들면 될 듯

 

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

원하는 내용을 작성 한다.

# ✨ feat: 사용자 로그인 기능 추가
# 🐛 fix: 댓글 생성 시 발생하는 NullPointerException 수정
# 💡 chore: 불필요한 로그 제거 및 변수명 수정
# 📝 docs: README에 프로젝트 설명 추가
# 🚚 build: Dockerfile 수정하여 실행 오류 해결
# ✅ test: 게시글 API 단위 테스트 추가
# ♻️ refactor: 중복 코드 제거 및 함수 분리
# 🚑 hotfix: 프로덕션 장애 수정 - 잘못된 URL 패턴 수정

 

여기에 작성된 내용이 커밋 할 때 마다 등장한다.

커밋 규칙이라던지, 그 때 그 때 쓰면 유용할 내용들을 적은 뒤,

 

3. 메시지 설정 완료하기

터미널에

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

를 작성해주면, 설정이 완료된다.

 

4. 사용법

설정해두면, 커밋을 할 때 마다 내가 설정해둔 파일 내용 전체가 뜨는데,

#이 앞에 있으면 주석으로 표시되어, 반영은 안된다.

 

따라서, 커밋메세지 템플릿이 자동으로 뜨면

사용할 부분의 #만 지워주고 내용을 수정해주면 됨

💡
Commit message의 Title과 Contents를 작성하려면
맨 상단이 Tilte이 되고, 한 줄 줄바꿈이 되면 그 이후로는 Contents이다.

그러면 이렇게 커밋이 생성된 걸 확인할 수 있다.