🐰 Commit Message
목적
Commit Message를 통해서 추가/ 수정사항에 Commit Message만으로 빠르게 원하는 커밋 내용을 확인하고 파악하게 하는데 있다.
7가지 규칙
-
본문과 주제를 공백 라인으로 구분한다.
-
제목 줄을 50자 이내로 작성한다.
-
제목 첫 글자를 대문자로 작성한다.
-
제목 줄을 마침표로 끝내지 않는다.
-
제목은 명령조로 작성한다.
-
본문을 72자마다 줄 바꿈 한다.
-
본문은 '어떻게'보다 '무엇을', '왜'에 맞춰 작성한다.
구조
<type>: <subject>
<body>
<footer>제목(Subject)
-
Type과 함께 헤더를 구성한다.
-
예를 들어, 로그인 API를 추가했다면 다음과 같이 구성할 수 있다.
ex) feat: Add login api
본문(Body)
-
생략 가능하며, 제목 라인과 반드시 한 줄을 띄운다.
-
각 줄은 최대 72자를 넘지 않도록 한다.
-
'어떻게'보다
무엇을,왜에 맞춰 작성한다.
꼬리말(Footer)
-
선택사항이며, 해당 커밋과 연관된 이슈 트래킹 번호를 입력한다. 예) Fixes: #1235, #1236
-
주로 Closes(종료), Fixes(수정), Resolves(해결), Ref(참고), Related to(관련) 키워드를 사용한다.
타입(type)의 종류
-
feat: 새로운 기능을 추가, 기존의 기능을 요구 사항에 맞추어 수정한 경우
-
fix: 기능에 대한 버그 수정한 경우 -
build: 빌드 관련 수정했을 경우 -
docs: 문서(주석) 수정했을 경우 -
style: UI를 추가/변경 하거나 스타일 관련 작업을 했을 경우 -
refactor: 기능의 변화가 아닌 코드 리팩터링
ex) 변수 이름 변경 -
test: 테스트 코드 추가/수정 했을 경우 -
chore:기능/테스트 코드, 문서, 스타일, 리팩토링을 제외한 배포, 빌드 등과 같이 프로젝트의 기타 작업들에 대해 추가/ 수정했을 경우 -
release: 릴리스를 하기 위해 패키지 버전을 올리거나, 릴리스 버전 커밋을 찍기 위한 경우
참고
Git Commit Message Style Guide
더 나은 Git 커밋 메시지 작성 패턴
[Git] Commit message 규칙
