Git 커밋 메시지 컨벤션

Kim, Sujin·2022년 11월 3일

오늘의 주제는 Git Commit Message Convention

왜 필요한가

서로 협업을 할 때, 내가 커밋 메시지를 '잘' 작성했다면
함께 협업하는 동료들, 그리고 미래의 나 에게도
당시 코드의 의미와 변경사항 등을 알 수 있게 해줍니다.
물론 코드를 읽는 것으로도 얼추 알 수 있겠지만 (가독성이 좋다면 !?)
메시지를 통해 직관적으로 빠르게 알려준다면 코드를 읽기에도 수월해지고 시간도 절약되겠죠 !

다만, 메시지를 내 맘대로 적으면 상대방이 엥?? 할 수도 있으니,
간결하고 읽기 쉽게, 규칙을 지켜서 메시지를 작성하여
읽는 사람 누구나 알기 쉽게 하는 것이 중요합니다 - !

구조 및 규칙

이미 많은 개발자들이 사용하고 있는, 관용적으로 쓰이는 스타일들이 존재합니다.

일반적으로 많이 사용되는 구조는 다음과 같습니다.

type: subject
body
footer

type은 필수로 작성해야 하고,
body와 footer는 상황에 맞게 선택해서 쓰면 됩니다.

또한 각 사항들은 빈 줄로 구분합니다.

subject : What

type: subject

가급적 50자 이하로 쓴다.
최대한 간결하게 작성한다.
현재시제, 명령형의 동사로 시작한다.
첫 글자는 대문자로 시작한다.
마침표는 생략한다.
type
- FEAT : 새로운 기능 추가
- FIX : 버그 수정
- DOCS : 문서 수정
- STYLE : code formatting, 세미콜론 누락, 코드 변경이 없는 경우
- REFACTOR : 코드 리팩토링
- TEST : 테스트 코드, 리팩토링 테스트 코드 추가
- CHORE : 빌드 업무 수정, 패키지 매니저 수정