Commit Message Conventions
Git 커밋 메시지의 중요성은 익히 들어서 알고는 있지만,
실제로 실천하는 것은 또 다른 이야기입니다.
특히 그룹 프로젝트 등 다른 분들과 협업을 시작할 때
코드 스타일과 더불어 커밋 메시지 컨벤션을 정해 놓기 위해 협의하곤 하는데,
무엇을 기준으로 정하는 게 좋을지 애매할 때가 있습니다.
그럴 때 참고할 만한 커밋 메시지 컨벤션을 하나 가져와 봤습니다.
Format
<유형>(<범위>): <주제>
<빈 줄>
<본문>
<빈 줄>
<꼬리말>
Shell
복사
기본적으로 커밋 메시지를 영문으로 작성하는 경우를 기준으로 합니다.
커밋 메시지는 한 줄에 100자를 넘을 수 없습니다!
유형
•
feat: 기능
•
fix: 버그 수정
•
docs: 문서
•
style: 포매팅, 세미콜론 누락 등
•
refactor: 리팩터링
•
test: 누락된 테스트 추가
•
chore: 유지(기타 등등)
범위
•
$location과 같이 커밋이 수행된 위치를 명시합니다.
•
일반적으로 선택 사항입니다.
주제
•
명령형과 현재 시제를 사용합니다.
change (O)
changed (X)
changes (X)
•
첫 번째 글자를 대문자로 쓰지 않습니다.
•
문장 마지막에 온점(.)을 찍지 않습니다.
본문
•
주제와 마찬가지로 명령형과 현재 시제를 사용합니다.
•
변경 이유를 작성하고 변경 이전과 대조합니다.
꼬리말
•
다른 구성 요소에 영향을 미칠 수 있는 변경 사항의 경우
꼬리말에 구체적인 변경 사항과 함께 타당한 이유를 기재해야 합니다.
•
종료된 이슈는 Closes #123과 같은 형태로 별도의 줄에 나열합니다.
아래 레퍼런스에 다양한 커밋 메시지 예시와 추가적인 내용이 소개되어 있으니,
관심 있는 분들은 참고하시면 좋을 것 같습니다!