로컬 환경에서 코드를 수정하고, add와 commit이란 작업을 하는데 commit message를 남길 때 규칙이 있다.
Commit message 7가지 규칙
- 제목과 본문을 빈 행으로 구문한다
- 제목을 50글자 내로 제한
- 제목 첫 글자는 대문자로 작성
- 제목 끝에 마침표 넣지 않기
- 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
- 본문의 각 행은 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과 함께 헤더 자리에 위치한다. ex) feat: Add login (로그인 API를 추가했다는 의미이다.)
Body
헤더에서 표현 가능하다면 생략할 수 있다. 아니라면 본문을 작성하면 된다.
Footer
어떤 issue에 대한 commit 인지 issue number를 담고 있다.
참고 자료: