Git commit template 등록하기

Bobby·2021년 8월 17일
0

즐거운 개발일지

목록 보기
2/22
post-thumbnail

작업을 완료하면 커밋 메시지를 남긴다.
여러명이 협업을 하게 된다면 규칙을 정해 메시지를 남기면 관리가 수월하다.
혼자서 작업한다 하더라도 이전 커밋이 무슨 작업을 했는지 명확하게 볼 수 있도록 메시지를 남기는 것이 좋겠다.

커밋 메시지 템플릿을 만들어서 커밋 메시지를 이쁘게(?) 날려보자.


1. 커밋 메시지 작성

  • 팀의 커밋 메시지 규칙에 맞도록 메시지를 작성한다.

< gitmessage >

# <타입>: <제목>

##### 제목은 최대 50 글자까지만 입력 ############## -> |


# 본문은 위에 작성
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |

# 꼬릿말은 아래에 작성: ex) #이슈 번호

# --- COMMIT END ---
#   <타입> 리스트
#   feat     : 기능 (새로운 기능)
#   fix      : 버그 (버그 수정)
#   refactor : 리팩토링
#   style    : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs     : 문서 (문서 추가, 수정, 삭제)
#   test     : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore    : 기타 변경사항 (빌드 스크립트 수정 등)
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------

2. 커밋 메시지 템플릿 등록

git config --global commit.template {path}/gitmessage

--global 옵션을 주면 모든 프로젝트에서 해당 템플릿을 사용
각 프로젝트마다 다른 템플릿을 사용하려면 프로젝트 루트 폴더에서 --global 옵션을 빼고 사용

  • global config 확인
git config --list
...

user.name={user_name}
user.email={user_email}
core.precomposeunicode=true
core.quotepath=false
commit.template={path}/gitmessage

...

각 프로젝트마다 다른 설정 정보는 .git/config 파일에서 확인 할 수있다.

3. 커밋 메시지 사용

git commit


참고

profile
물흐르듯 개발하다 대박나기

0개의 댓글