좋은 커밋 메시지를 작성하기 위한 규칙

커밋 메시지를 작성하기 위한 규칙들

개발을 하면서 많은 코드 컨벤션들이 있고 협업이 필수적인 업무 특성상 이러한 규칙들이 굉장히 중요하다고 느끼고 있습니다.
그 중 커밋 메세지는 어떤식으로 남겨야 좋을까..

커밋 메시지를 규칙성 있게 작성해야하는 이유

1) 커밋 로그 가독성
2) 더 나은 협업과 리뷰 프로세스
3) 유지보수 용이

규칙

• 커밋 메시지 구조

  타입: 제목
  본문
  꼬리말

• 타입
  Feat - 새로운 기능 추가
  Fix - 버그 수정
  Build - 빌드 관련 파일 수정
  Ci - CI관련 설정 수정
  Docs - 문서 (문서 추가, 수정, 삭제)
  Style - 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없는 경우)
  Refactor - 코드 리팩토링
  Test - 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없는 경우)
  Chore - 기타 변경사항 (빌드 스크립트 수정 등)

• 제목
  마침표를 붙이지 않는다
  과거시제사용하지 않고 명령조 작성
  제목과 본문은 한줄 띄워 작성
  제목의 첫글자는 대문자
  제목이나 본문에 이슈번호가 존재한다면 붙인다.

ex) Feat: 로그인 api 추가

• 본문(선택사항)

한줄에 72자를 넘기지 않는다
무엇을, 왜 에 맞춰서 작성한다

• 꼬리말(선태사항)

issue tracker id를 작성할때 사용
해결: 이슈 해결 시 사용
관련: 해당 commit에 관련된 이슈 번호
참고: 참고할 이슈가 있는 경우 사용

좋은 커밋 메시지 작성 규칙에 대해 알아보았는데 결론적으로는 어떤 규칙이던간에
협업하는 팀원들과 소통 가능한 명확한 규칙을 가지고 간다면 의미가 있을것 같다.