Git - [ 커밋 메세지 규칙 ]

협업 경험은 아직 없고 개인 프로젝트를 진행하며 혼자 커밋 메세지를 남겼었는데, 내가 봐도 뭘 남기려고 한 건지 못 알아보는 일이 종종 있어서 앞으로는 커밋 메세지를 작성할 때 규칙을 지켜서 작성하고자 한다.

 

좋은 Git 커밋 메시지의 7가지 규칙

1. 제목과 본문을 한 줄 띄워 분리
2. 제목은 영문 기준 50자 이내
3. 제목 첫 글자를 대문자로
4. 제목 끝에 마침표 금지
5. 제목은 명령조로
6. 본문은 영문 기준 72자마다 줄 바꾸기
7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

 

 

 

커밋 메세지 구조

type(옵션): Subject // 제목

body(옵션) // 본문

footer(옵션) // 꼬리말

 

제목은 필수 요소, 바디와 푸터는 옵션이다.

type

• feat: 새로운 기능 추가
• fix: 버그 해결
• docs: 문서 변경
• design : CSS 등 사용자 UI 디자인 변경
• style: formatting, 놓친 세미콜론 등... 코드의 변경은 없음
• refactor: 코드 리팩토링
• test: 테스트 코드 추가 혹은 테스트 코드 리팩토링. 코드의 변경은 없음
• chore: 패키지 매니저 구성, 빌드 작업 업데이트. 코드의 변경은 없음
• rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
• remove : 파일을 삭제하는 작업만 수행한 경우
• comment : 필요한 주석 추가 및 변경

주제

주제는 50자를 넘어서는 안되며, 대문자로 시작해야 하며, 마침표로 끝나면 안된다.

명령형으로 작성한다. 

바디

바디는 옵션이고, 커밋이 약간의 설명과 문단이 필요할 때 바디가 사용된다. 

'어떻게'가 아닌 '무엇을' 그리고 '왜'에 대한 설명을 위해 바디를 사용해야한다.

바디를 적을 때, 타이틀과 바디 사이에 공백을 적어야 하고 각 줄에 글자가 72자를 넘지 않도록 해야한다.

푸터

옵션이고, 이슈트래커 아이디 참조로 사용된다.

• Resolves: 문의나, 요청에 의한 이슈에 해당하는 경우 이슈 번호
• Closes: 일반적인 개발과 관련된 이슈에 해당하는 경우 이슈 번호
• Fixes: 버그 픽스, 핫 픽스 관련 이슈에 해당하는 경우 이슈 번호
• See also: 커밋의 이슈와 연관되어 있는 이슈들이 존재 하는 경우, 또는 관련된 이슈들이 있는 경우 이슈 번호

참고로 close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved 와 같은 키워드와 함께 이슈번호를 기입하면 커밋 메세지에서 이슈를 닫을 수 있다.

사용 시점	사용 키워드
해결	Closes(종료), Fixes(수정), Resolves(해결)
참고	Ref(참고), Related to(관련), See also(참고)

 

 

ex) 아래와 같이 커밋 메세지 남기면 100번 이슈 종료됨

feat: ㅇㅇ 기능 추가

ㅇㅇ 기능 추가개발함 
  * ㅇㅇ 개발
  * ~~참고

resolved : #100
see also : #101, #102​

---

참조

https://cocoon1787.tistory.com/708

[Git] 좋은 커밋 메시지 작성법

https://jae04099.tistory.com/entry/GIT-%EC%BB%A4%EB%B0%8B%EC%97%90-%EA%B4%80%ED%95%98%EC%97%AC%EC%A2%8B%EC%9D%80-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EC%BB%A4%EB%B0%8B-%ED%83%80%EC%9D%B4%EB%B0%8D-%EB%93%B1

[GIT] 커밋에 관하여(좋은 커밋 메시지, 커밋 타이밍 등)

https://overcome-the-limits.tistory.com/entry/%ED%98%91%EC%97%85-%ED%98%91%EC%97%85%EC%9D%84-%EC%9C%84%ED%95%9C-%EA%B8%B0%EB%B3%B8%EC%A0%81%EC%9D%B8-git-%EC%BB%A4%EB%B0%8B%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0

[협업] 협업을 위한 git 커밋컨벤션 설정하기

https://blog.munilive.com/posts/my-git-commit-guide.html

Git Commit Message Style Guide - 개인/팀을 위한 커밋 메시지 스타일 가이드

https://greenzoo.tistory.com/36

Git 커밋 메세지 스타일 가이드 및 Issue 종료하기

https://jane-aeiou.tistory.com/m/93