[Git] Git Commit Message Convention

 지금까지 혼자 공부하면서 마음대로 커밋 메시지를 작성해 왔었다,, 하지만 이제 프론트엔드 분들과 협업을 진행하게 되면서 '깃 커밋 메시지 컨벤션'이라는 많은 개발자 분들이 따르는 관습을 공부하고 지켜보려고 한다. 이러한 과정이 후에 또 다른 분들과 협업을 진행함에 있어 큰 도움이 되기를 바란다.

 

 Git commit message convention이란, Git을 사용하여 프로젝트를 관리할 때 개발자 분들이 커밋 메시지를 일관된 형식으로 작성할 수 있도록 지침을 제공하는 것을 말한다. 이렇게 일관된 커멧 메시지 형식은 프로젝트의 유지보수성과 협업 효율성을 높이는 데 중요한 역할을 한다.

 

 팀 회의를 통해 Udacity Git Commit Message Style Guide를 참고하여 사용하기로 했다.

Udacity Nanodegree Style Guide

 

 

 

 

 

 커밋 메시지 구조는 다음과 같다.

type: subject

body

footer

 

• 타입(type)
  : 커밋의 성격을 나타내는 분류자이다. 다음은 Udacity에서 권장하는 7개 종류의 타입이다.
  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 변경이 없는 수정 ex) 세미콜론(;), 들여 쓰기
  • refactor : 코드 리팩토링
  • test : 테스트 코드 추가 또는 수정
  • chore : 빌드 태스크 업데이트, 패키지 매니저 설정 등의 변경 사항
    
    
    
• 제목(subject)
  • 제목은 간결하게 50자 이내로 작성하고 마침표를 찍지 않는다.
  • 제목의 시작은 대문자로 작성한다.
  • 영문으로 표기하는 경우 동사 단어로 작성을 시작한다.
    
    
    
• 본문(body)
  • 변경 사항에 대한 자세한 내용으로 최대 75자를 넘기지 않도록 한다.
  • 선택 사항이며, 제목과 본문 사이에 한 줄을 띄워 작성한다.
  • 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성한다.
    
    
    
• 꼬리말(footer)
  : 이슈 번호나 커밋 메시지와 관련된 이슈 번호, 릴리즈 정보 등을 작성한다.