Skip to content

Commit message template

joi0104 edited this page Aug 8, 2020 · 8 revisions

커밋메시지 템플릿은 다음과 같습니다.

<타입>(!): #<이슈 번호>. <제목>

# ---
# 제목은 한글로
# 제목은 명령문으로
# 제목 끝에 마침표(.) 금지
# 제목과 본문을 한 줄 띄워 분리하기
# 본문은 "어떻게" 보다 "무엇을", "왜"를 설명하기.
# 본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# 제목은 최대 30글자 까지 작성
# 본문은 한 줄에 최대 72글자 까지 작성합니다.
# ---

# ----
# <타입> 리스트
# feat : 새로운 기능
# fix : 버그 수정
# refactor : 코드 리팩터링 (코드 스타일 변경도 포함, 비즈니스 로직에 변경 없음 )
# docs : 문서 추가, 수정, 삭제
# test : 테스트 코드 추가, 수정, 삭제 (비즈니스 로직에 변경 없음 )
# chore : 기타 변경사항 (스크립트 수정 등)
# BREAKING CHANGE가 필요할 땐 타입 옆에 느낌표를 넣어주세요.
# ---

주의사항

  • Commit message template는 Conventional Commit 규약을 따릅니다.
  • scope는 작성하지 않습니다.

commit message template 설정

https://junwoo45.github.io/2020-02-06-commit_template/

  • gitmessage.txt 생성
vim ~/.gitmessage.txt
템플릿 붙여넣기
:wq
  • git config 설정
 # 현재 저장소에만 설정
 git config commit.template ~/.gitmessage.txt

 # 전역으로 설정
 git config --global commit.template ~/.gitmessage.txt

git commit 명령어로 지정된 커밋 템플릿을 불러올 수 있습니다. :wq 저장으로 커밋 메시지를 남길 수 있습니다.

husky 이용해서 commitlint, eslint 설정

"husky": {
    "hooks": {
      "pre-commit": "npm run checkTs && lint-staged",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },