포스팅 목적
git 에서 좋은 commit 메세지를 작성하기 위한 규칙을 알아봅니다.
commit 메세지란?
버전 관리를 하는 프로그램 ( git 등 ) 에서 반영한 코드에 대한 설명을 말합니다. 보통 반영한 내용을 요약해서 작성합니다.
commit 메세지는 강제적인 것이 아니고 따로 형식이 지정되어 있지 않기 때문에 개발자가 임의로 입력할 수 있습니다. 코드가 어떤 기능을 하는지 잘 설명이 되어 있다면 전체 변경사항을 하나하나 확인할 필요가 없고 커뮤니케이션에 도움이 되기 때문에 일정에 형식에 따라 입력하는 것이 좋습니다.
널리 쓰이는 규칙이 있는데 팀이나 프로젝트에 효율적인 형식을 새로 정하거나 아래와 같은 형식을 따르면 됩니다.
좋은 커밋 메세지 작성을 위한 방법
메세지 구조
분류: 제목
본문 [선택 사항]
꼬리말 [선택 사항]
메세지 구조 상세 내용
깃의 특성에 따라 깃 터미널에서 깔끔하게 한 줄로 보이거나 다른 프로그램과 연동하기 위해 정해진 형식 입니다.
- 제목과 본문을 한 줄 띄워 분리하기
- 제목은 영문 기준 50자 이내로
- 제목 첫글자를 대문자로
- 제목 끝에 . 금지
- 제목은 명령조로
- 본문은 영문 기준 72자마다 줄 바꾸기
- 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기
- 꼬리말은 이슈(#id)를 추적
분류의 종류
- feat : 새로운 기능
- fix : 문제 수정
- build : 빌드 관련 파일 수정
- chore : 그 외 자잘한 수정
- ci : CI 관련 설정 수정
- docs : 문서 수정
- style : 코드 스타일 혹은 포맷 수정
- refactor : 코드 리팩토링
- test : 테스트 코드 수정
분류의 종류가 2개 이상 섞여 있는 경우는 하나의 commit 에 수정 사항이 많은 것이므로 나누어 commit 하는 것이 좋습니다.
습관을 위한 방법
- 편집기의 확장 도구를 이용
Conventional Commits
Visual Studio Code Commitizen Support - 커스텀 템플릿 만들기
참고 자료
- Udacity Git Commit Message Style Guide
- Visual Studio Code Commitizen Support
- 좋은 git 커밋 메시지를 작성하기 위한 7가지 약속
- 좋은 커밋 메시지를 작성하기 위한 커밋 템플릿 만들어보기