[Git] commit message convention

협업을 하다보면 원활한 커뮤니케이션을 위해 규칙이 필요하다.
Git 커밋 메세지에도 가독성을 위해 규칙이 필요한 것 같아서 정리한다.

 

Commit message structure

일반적으로 커밋 메세지 구조는 제목-본문-꼬리말 구성이다.
이때 각 파트는 한 줄을 띄어서 분리시킨다.

제목

본문

꼬리말

그러나 커밋을 자주 하는 경우엔 구성을 맞추는 것도 일이된다.
그래서 간결한 커밋 메세지를 지향한다면 한 줄 이내로 메세지를 작성하기도 한다.

 

Commit Tag Type

Tag Name	Description
Feat	새로운 기능을 추가
Fix	버그 수정
Design	CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment	필요한 주석 추가 및 변경
Docs	문서 수정
Test	테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
Chore	빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우

---

Reference

• https://velog.io/@archivvonjang/Git-Commit-Message-Convention