개발
git
[git] 커밋 메시지 컨벤션
2023년 02월 18일 by Hwang
좀 더 일관성있는 커밋 메시지를 남기기 위해서 커밋 컨벤션을 조사해보다 가장 많이 쓰이는 컨벤션인 것 같아 정리해보았다.
메시지 구조
커밋 메세지는 제목, 본문, 꼬리말로 구분한다.
제목 - type: Subject
본문 - body
꼬리말 - footer
제목은 타입과 제목으로 구성된다.
[ Type ]
- feat : 새로운 기능 추가
- fix : 버그 수정
- docs : 문서 변경
- style : 스타일 변경 (포매팅 수정, 들여쓰기 추가, 세미콜론 추가)
- refactor : 코드 리팩토링
- test : 테스트 관련 코드
- chore : 빌드 관련 파일 수정, 패키지 매니저 수정
- perf : 성능 개선
[ Subject ]
- 제목은 50자 이하여야 하고, 대문자로 시작하며 마침표로 끝나지 않는다.
- 제목은 동사로 시작하여 명령형으로 작성한다.
[ body ]
- 선택 사항이며 커밋에 약간의 설명이 필요할 때 작성한다.
- 본문은 한 줄 당 72자 내로 작성한다.
[ footer ]
선택사항이고 이슈 트래커 ID를 작성할 때 사용한다.
커밋 메시지 헤더
<type>(<scope>): <short summary>
│ │ │
│ │ └─⫸ 명령문, 현재 시제로 작성합니다. 대문자를 사용하지 않으며, 마침표로 끝내지 않습니다.
│ │
│ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
│ elements|forms|http|language-service|localize|platform-browser|
│ platform-browser-dynamic|platform-server|router|service-worker|
│ upgrade|zone.js|packaging|changelog|dev-infra|docs-infra|migrations|
│ ngcc|ve
│
└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
The <type> and <summary> fields are mandatory, the (<scope>) field is optional.
Comment