커밋 메세지 컨벤션 규약은 여러 가지로 나뉘어져 있지만
Udacity의 커밋 메세지 스타일 가이드를 참조한 내용입니다.
type : subject
body
footer
태그 : 제목의 형태이며, :뒤에만 space가 있음에 유의한다.
- feat: 새로운 기능 추가
- fix: 버그 수정
- design: CSS등 사용자 UI 디자인 변경
- breaking change: 커다란 API 변경의 경우
- hotfix: 급하게 치명적인 버그를 고쳐야하는 경우
- style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
- refactor: 프로덕션 코드 리팩토링
- comment: 필요한 주석 추가 및 변경
- docs: 문서를 수정한 경우
- test: 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
- chore: 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
- rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
- remove: 파일을 삭제하는 작업만 수행한 경우
- 제목은 50자를 넘기지 않고, 영문으로 표기하는 경우 첫 글자는 대문자로 작성하고 마침표를 붙이지 않는다.
- 과거시제를 사용하지 않고 명령어로 작성한다.
- 선택사항이기 때문에 모든 커밋에 본문내용을 작성할 필요는 없다.
- 부연설명이 필요하거나 커밋의 이유를 설명할 경우 작성해준다.
- 72자를 넘기지 않고 제목과 구분되기 위해 한칸을 띄워 작성한다.
- 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.
- 꼬리말은 optional이고 이슈 트래커 ID를 작성한다.
- 꼬리말은 "유형: #이슈 번호" 형식으로 사용한다.
- 여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분한다.
- 이슈 트래커 유형은 다음 중 하나를 사용한다.
+ Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
+ Resolves: 이슈를 해결했을 때 사용
+ Ref: 참고할 이슈가 있을 때 사용
+ Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)