commit을 하면서도 메세지에 작업일자와 내용만 적고 끝내던 방식으로는 Git을 제대로 사용하는게 아니라고 생각해서 커밋 메세지 규칙을 찾아 정리했다.
Commit message 7가지 규칙
- 제목과 본문을 한 줄 띄어 구분
- 제목은 50자 이내
- 제목 첫 글자는 대문자
- 제목 끝에 마침표 X
- 제목은 명령문으로, 과거형 X
- 본문의 각 행은 72자 이내 (줄바꿈 사용)
- 본문은 어떻게 보다 무엇을, 왜에 대하여 설명
Commit message 구조
기본적으로 commit message 는 제목, 본문, 꼬리말로 구성한다.
제목은 필수사항이며, 본문과 꼬리말은 선택사항이다.
<type>: <subject>
<body>
<footer>Type
| 타입 | 내용 |
|---|---|
| feat | 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정 |
| fix | 기능에 대한 버그 수정 |
| build | 빌드 관련 수정 |
| chore | 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore |
| ci | CI 관련 설정 수정 |
| docs | 문서(주석) 수정 |
| style | 코드 스타일, 포맷팅에 대한 수정 |
| refactor | 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경 |
| test | 테스트 코드 추가/수정 |
| release | 버전 릴리즈 |
Subject
Type 과 함께 헤더를 구성한다. 예를들어, 로그인 API 를 추가했다면 다음과 같이 구성할 수 있다.
ex) feat: Add login api
Body
헤더로 표현이 가능하다면 생략이 가능한다. 아닌 경우에는 자세한 내용을 함께 적어 본문을 구성한다.
Footer
어떠한 이슈에 대한 commit인지, issue number 를 포함해야 한다. 위의 좋은 예시에서는 (#1) 처럼 포함시켰다. 그리고 close #1 처럼 close 를 통해 해당 이슈를 닫는 방법도 있다.
