Skip to content

Commit message 규칙

Zinzo edited this page Dec 9, 2023 · 3 revisions

1. 커밋 메세지 간단한 규칙

  • 대부분 간략한 내용으로 해당 commit이 구분 되게끔 작성하기
  • 본물을 작성해야 하는 경우, 한 줄 간격을 주고 작성하기
  • 본문은 어떻게 보다 무엇을, 왜에 대하여 설명
  • 제목은 50자 이내
  • 제목 끝에 마침표를 작성하지 않는다

2. 커밋 메세지 구조

<type>: <subject>

<body>

<footer>

예시

feat: 회원가입 기능 추가

body와 footer는 생략 가능


3. 종류

이름 종류
feat 새로운 기능이 추가 되었을 때, 혹은 기존에 만들어진 기능을 새로운 요구 사항에 맞추어 수정했을 경우
fix 만들어진 기능에 대해서 오류, 버그 등을 수정했을 경우
build 빌드와 관련된 내용을 변경했을 경우
chore 패키지 위치, 그 외 간단한 것들 수정 했을 경우 (ex, .gitignore)
ci CI 관련하여 변경 되었을 경우
docs 문서, 주석 등에 대한 수정
style 코드 스타일, 포맷팅에 대한 수정이 되었을 경우
refactor 기능에 대한 변화 없는 단순 코드 리팩터링의 경우 (ex, 변수 이름 수정)
test 테스트 코드를 추가하거나 수정한 경우

🔗 참고