나중에 후임이 들어왔을때나, 다른 사람과 협업을 할때 어떻게 하면 더 잘할 수 있을까 고민하다 통일성과 체계적인 일처리를 위해 커밋 컨벤션을 정리하기로 했다.
이 글은 유다시티의 커밋 메시지 스타일 가이드를 참조한 내용이다
- Commit 메시지 구조
기본 적인 커밋 메시지 구조는 제목,본문,꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분한다.
type : subject
body
footer
- Commit Type
타입은 태그와 제목으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 한다.
태그 : 제목의 형태이며, :뒤에만 space가 있음에 유의한다.
feat : 새로운 기능 추가fix : 버그 수정docs : 문서 수정style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우refactor : 코드 리펙토링test : 테스트 코드, 리펙토링 테스트 코드 추가chore : 빌드 업무 수정, 패키지 매니저 수정
- Subject
- 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다.
- 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기한다.(과거 시제를 사용하지 않는다.)
- 제목은 개조식 구문으로 작성한다. --> 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미.
* Fixed --> Fix
* Added --> Add
* Modified --> Modify
- Body
본문은 다음의 규칙을 지킨다.