깃허브 커밋 메시지 템플릿 도입하기

개요

 

이게뭐약 프로젝트에 이슈 템플릿을 도입한적이 있었다

이 템플릿에 맞춰 이슈를 생성하게 했고, 커밋을 올릴때마다 커밋 메시지에 

이슈번호, 작업 내용, 상세 내용을 기입하도록 했다

그러나 막상 작업을 하다보니 이슈 외 사항을 고칠때, 사소한 커밋일때 

이를 지키기가 어려웠다

갈수록 지저분해지는 커밋 기록을 깔끔하게 통일시킬 방도가 필요했다

 

 

 

 

 

커밋 메시지의 목표

- 상황별로 어떤 내용, 어떤 형식으로 남겨야하는지 안내

- 편리하게 컨벤션을 확인할 수 있도록 함

 

 

 

 

 

커밋 메시지 템플릿 적용

1. .gitmessage.txt 생성

################
# <타입>: <제목>
#
# [- 상세 내용]
# 
# [이슈 번호]
################

################
# - 제목엔 변경 사항이 "무엇"인지 명확하게 작성
# - 제목 끝에 마침표 금지
# - 커밋 메시지 내 줄바꿈 준수
# - 이슈와 관련된 작업은 반드시 "이슈 번호" 기입
# - 제목만으로 표현 가능한 간단한 작업은 "상세 내용" 생략 가능
# 예시)
# feat: 상세정보 API 개선
#
# - 식의약 데이터 포털 API 대신 DB를 쿼리하도록 수정
# - 상세 정보 로직 관련 타입 정의
#
# #20
################

################
# feat : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refact : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
################

 

 

2. .git에 커밋 메시지 템플릿 적용

git config commit.template .gitmessage.txt

# vscode에서 git을 사용할 경우 --wait 설정을 사용하면 새롭게 나타는 vs code 인스턴스를 닫을 때까지 명령을 대기하도록 설정할 수 있다.
# 따라서 COMMIT_EDITMSG 파일을 띄우고 터미널로 작업이 전환되지 않고 vscode 인스턴스가 닫을때까지(작업이 끝날때까지) 대기하게 된다.
git config --global core.editor "code --wait"

 

 

3. 적용 확인

git add .
git commit

 

 

 

 

 

후기

VSCode의 소스제어 기능을 사용하는 나로서는 생각보다 불편했다

터미널에 git commit을 입력할때만 나와가지고 딱히 유용하지는 않았지만,

팀원들에게는 유용할 것이라 믿고 일단 도입해봤다

개선할 점이 있다면 앞으로 개선을 시켜보자

 

 

 

 

 

Reference

https://velog.io/@leewooseong/Git-Messagecommit-message-template

Git Message(commit message template)