깃 커밋 메시지 컨벤션(Commit Convention), 커밋 메시지 작성요령

 

커밋 메시지를 통일된 양식으로 작성하면 추후 어떠한 부분이 변경되었는지 알기도 쉽고 협업을 할 때도 도움이 된다. 따라서 메시지를 작성하는 컨벤션을 정리해보려고 한다.

커밋 메시지는 크게 제목(Title), 본문(Body), 꼬리말(Footer)의 세 부분으로 구성된다.

Type : Title
Body
Footer

 

Type

---

커밋하는 메시지의 타입을 설명해준다. 예를 들어, 버그 수정인지 새로운 기능의 추가인지 등이다.

• feat : 새로운 기능, 코드 추가
• add : 파일 추가
• fix : 버그 수정
• refactor : 코드 리팩토링
• docs : 문서 수정
• style : 코드 형식, 정렬, 주석 등의 변경(동작에 영향을 주지 않는 변경사항)
• test : 테스트 코드에 관련된 변경 사항
• chore : 빌드 업무 수정, 패키지 매니저 설정 등

 

Title

---

• 제목은 50자를 넘기지 않는다.
• 첫글자는 대문자로 작성
• 마침표를 붙이지 않는다.
• 과거 시제를 사용하지 않는다.
  • Fixed->Fix
  • Changed->Change

 

Body

---

• 선택사항이므로 작성하지 않아도 무방
• 부연설명이나 커밋의 이유를 설명
• 제목과 구분짓기 위해 한 칸 띄우고 작성한다

 

Footer

---

• 마찬가지로 선택사항이다
• 이슈 트래커 ID를 작성할 때 쓴다.