[Git] 커밋메시지 컨벤션 정하기

서론

Git을 사용하면서 느낀 것 중에 하나가 커밋 메시지를 잘 써야 한다는 것이었다.

다른 사람들과 Git을 사용하여 함께 프로젝트를 할 때 커밋 메시지를 작업한 내용에 대한 내용이 없이 년월일만 작성한다던가 사번만 작성하는 분들이 (생각보다 많이) 계셨다.
심지어 ‘asdf’ 로 작성한 커밋 메시지까지도 본 적이 있다.

앞으로의 프로젝트 팀원들과 나 자신을 위해서도 나름대로의 커밋 메시지 컨벤션을 정해서 지키려고 한다.

다음은 Udacity Git Commit Message Style Guide 를 참고하여 정한 내용이다.

커밋 메시지 작성 규칙

커밋 메시지는 다음과 같이 크게 제목, 본문, 바닥글로 구분한다.

type : Subject
<br/>
Body
<br/>
Footer

type

유형은 제목 앞에 들어가야 하며, 다음과 같이 크게 7가지로 분류한다.

• feat : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 코드 포맷팅, 세미콜론 누락. 그 밖에 코드의 변경이 없는 경우
• refactor : 코드 리팩토링
• test : 테스트 코드, 리펙토링 테스트 코드. 그 밖에 코드에 변경이 없는 경우
• chore : 빌드 업무 업데이트, 패키지 매니저 수정. 그 밖에 코드의 변경이 없는 경우

Subject

• 제목은 50자 이하로 작성하도록 한다.
• 끝에 마침표를 붙이지 않는다.

Body (선택)

• 본문은 선택사항으로 부가 설명이 필요하거나 커밋의 이유를 전달해야할 경우 작성한다.
• 무엇을, 왜 변경하였는지를 설명하는 내용을 작성한다.
• 한 줄에 72자를 넘기지 않도록 한다.
• 제목과 구분되도록 한 줄을 띄우고 작성한다.

Footer (선택)

• 바닥글은 선택사항으로 이슈를 추적하기 위해 이슈 트래커 ID를 넣어준다.
• 해결된 이슈도 추가하여 준다.

결론

향후 몇 년간은 해외에서 일할 일이 없을 것 같아서 우선 한글로 커밋 메시지를 작성하며 익히려고 한다.
미래의 나를 위해서라도 커밋 메시지를 동일한 규칙에 따라 작성할 수 있도록 하겠다.
아, 팀에서 정한 커밋 메시지 컨벤션이 있다면 그것을 우선적으로 따르자.

참조

• Udacity Git Commit Message Style Guide