Git 에서는 History 를 Commit Message 를 통해 확인합니다. Git Commit Message 를 잘 작성해야 하는 이유는 여러 가지가 있습니다.
- 더 좋은 커밋 로그 가독성
커밋 메시지를 메뉴얼에 따라 작성하면, 커밋 로그의 가독성이 높아집니다. - 더 나은 협업과 리뷰 프로세스
협업을 하는데 커밋 메시지를 마구잡이로 작성한다면, 팀원이 이 코드를 왜 작성했는 지 파악할 수 없기 때문에, 협업을 할 때에 신경 써서 커밋 메시지를 작성할 필요가 있습니다. - 더 쉬운 코드 유지보수
커밋 메시지가 잘 작성되어 있으면, 내가 어떤 코드를 어디에 작성했는지 쉽게 찾을 수 있기 때문에 유지보수가 쉽습니다.
아래에서는 좋은 Git Commit Message를 작성하기 위한 6가지에 대해 알아보겠습니다. (영문 기준)
- 제목과 본문을 한 줄 띄워 분리하기
- 제목은 영문 기준 50자 이내로 (한글 기준 70자 이내)
- 제목 끝에
.금지 - 제목은 명령조로
- 본문은 영문 기준 72자마다 줄 바꾸기
- 본문은 어떻게 보다 무엇을, 왜 에 맞춰 작성하기
Git Commit Message의 규칙
커밋 메시지는 아래와 같은 구조로 이루어집니다.
타입(적용 범위-선택사항): 설명
본문(선택사항)
꼬리말(선택사항)
- 타입 : 어떤 의도로 커밋했는지를 타입에 명시합니다.
- 적용 범위 : 코드베이스가 적용되는 영역을 기술하는 명사로 괄호로 감싸져야 합니다.
- 본문 : 최대 50글자가 넘지 않도록 하고 마침표는 찍지 않습니다. 영문으로 표기하는 경우 동사를 가장 앞에 두고 첫 글자는 대문자로 표기합니다.
- 본문 : 긴 설명이 필요한 경우에 작성합니다. 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성합니다. 최대 75자를 넘기지 않도록 합니다.
- 꼬리말 : issue tracker ID를 명시하고 싶은 경우에 작성합니다.
메시지 구조를 어떻게 더 명확하게 작성할 수 있는지 알아보겠습니다.
제목(subject, 필수)
WHAT 무엇을 했는지
형태
타입(적용 범위): 설명
- :과 설명사이에 한 개의 공백을 유지하고 작성할 것
- type은 대문자나, 소문자 하나로 통일을 권장
- 설명 일관되게 통일(~기능 구현, ~작성, ~출력, ~삭제, ~생성, ~수정..)
- 명령형, 현재형으로 작성하기
- 끝에
.금지 - 적용 범위는 추가적인 문맥 정보를 제공하기 위한 목적으로 작성
feat: 회원가입 기능을 개발함 (x) feat(api): 회원가입 기능 개발 (o) feat: 회원가입 기능 개발. (x)
타입
feat: 새로운 기능(기능 구현)fix: 버그 수정docs: documentation 변경style: 코드 의미에 영향을 주지 않는, 코드 스타일에 관련된 변경 사항(포맷, 공백, 세미콜론, 함수 이름 변경, 줄간격, 파일 이름, 의미 없는 주석)refactor: 리팩토링에 대한 커밋(버그 수정x, 기능 추가x)chore: 패키지 매니저 설정할 경우, 코드 수정 없이 설정 변경(eslint, prettier... 패키지 설정), 이외의 애매한 작업들feat: 회원가입 기능 개발 fix: 회원가입 시 사용자 이름이 안보이는 이슈
내용(body, description, 선택)
WHY 왜 이 커밋을 작성하게 됐는지, 왜 그렇게 했는지
- 일반적으로 제목까지만 기재하고, 선택사항으로 기재
- 약간의 설명이나 전체 문맥을 설명해야 할 때만 사용
- commit 메세지는 간단히 요약한 내용을 작성하고, 부족한 부분이 있으면 description 에 추가
- 작성할 때는 커밋에 대해 어떻게가 아닌 무엇 그리고 이유에 대해 설명
- 현재형으로 작성
- 본문을 작성하고 싶을 때는, 제목과 본문을 한 줄 띄워서 분리
마무리(Footer, 선택)
이슈트래킹을 위해 ID 를 참조할 때 사용합니다.
Resolved: #110좋은 Commit 예시
feat(auth): 회원 가입 기능 구현
SMS, 이메일 중복확인 API 개발
Resolves: #123
Ref: #456
Related to: #48, #45지금까지 Git Commit Convention 에 대해서 자세히 알아보았습니다. 실제로 깃을 활용해 협업을 하다보면 Convention 을 정해도 규칙을 준수하지 않는 경우가 종종 있습니다. 잘 지켜지지 않은 커밋 메시지는 잘 읽어지지 않기 때문에, 컨벤션을 정했다면 팀 문화에 맞게 잘 지키는 습관을 가지는 것이 중요할 것 같습니다.
Commercial Art