Git Commit Message 작성 규칙
깃 커밋 메시지 작성할 때 일관성 없이 작성을 하게 되면 가독성이 매우 떨어지고, 특히 협업을 할 경우 이러한 문제는 더욱 드러나게 된다. 때문에 깃 커밋 메시지를 작성 시 일관성 있는 규칙을 지켜 작성하는 것이 좋다. 다음은 Udacity Git 커밋 메시지 스타일 가이드이다.
## Message Structure
깃 커밋 메시지는 제목/본문/꼬리말로 구성되며 작성 시 개행으로 서로를 구분하여 작성해준다.
type: Subject
body
footer
Type
제목에 해당하는 부분
- feat: 새로운 기능을 추가
- fix: 버그 수정
- docs: 문서 수정
- style: 포맷팅, 코드 변경 없는 수정
- refactor: 리팩토링
- test: 테스트 코드
- chore: 빌드 업무 수정, 패키지 업무 수정
- rename: 파일 혹은 폴더명 수정
- remove: 파일 삭제하는 작업
- comment: 필요한 주석 추가/삭제
Subject
- 제목은 50자 내로 작성해야 한다.
- 과거 시제 사용하지 않는다.
- 마침표를 붙이지 않는다.
- 명령어로 작성을 시작한다. (ex. "Add", "Fix",...)
Body
- 선택 사항: 커밋에 추가적인 설명이나 컨텍스트가 필요한 경우에만 작성해도 된다.
- Body 작성 내용은 커밋의 내용이나 이유를 설명하는 것이 아닌 방법을 적어야 한다.
- 본문은 72자 내로 작성해야 한다.
Footer
- 선택 사항: 문제 추적기 ID를 참조하는데 사용한다.