[Git] Git Commit Message Convention 정리

 

 

 

Git Commit Message Convention 에 대해 기록하는 포스팅을 하고자 한다.

 

사실 깃 메시지 컨벤션은 협업 시 일관성을 위해 필요하지만 회사마다 스타일이 다르다.

 

일반적으로 Github 내에서 사람들이 자주 사용하는 깃 메시지 컨벤션이 아닌 Jira 일감번호, Github 이슈번호, 라벨까지만 달고 작업 단위로 내용만 추가해서 메시지를 작성하는 경우도 많다. 

 

그래도 일반적으로 공용화 되는 깃 메시지 컨벤션은 있으니 이에 대해 알아보려한다.

[대한민국에서 외국인하고 협업해서 영어로 커밋하는 회사는 드문걸로 알고 있다. 그래서 영문에 집중된 컨벤션은 생략하겠다]

 

 

깃 커밋메시지는 크게

1. [타입(type)] 제목(title, subject) 

2. 본문내용(body)

3. 꼬리말(footer)

로 이루어진다.

 

차례대로 살펴보겠다.

 

1. [타입(type)] 제목(title, subject) 

먼저 타입이다.

이때까지 Github에서 본바로는 보통 사람들이 가장 많이 사용하는 커밋메시지 컨벤션 타입은 다음과 같다.

• feat: 새로운 기능 추가 
• fix: 버그 픽스 
• docs: 문서 수정
• style: 포맷,  세미콜론 수정, Optimize import, Code clean up 등 코드가 아닌 스타일에 관련된 수정 
• refactor: 코드 리펙토링
• test: 테스트 코드 추가
• chore: 빌드 관련 업무 수정(안드로이드의 경우 builde.gradle, manifest)

 

 

그리고 내가 처음 접하고 가장 많이 사용해온 컨벤션은 다음과 같다. 원래 Refactor 대신 Revise로 사용했었다.

밑 사이트가 출처인데 이걸 나에 맞게 살짝 손좀 봤다.  blog.ull.im/engineering/2019/03/10/logs-on-git.html

ull.im

 

      FIX -> 올바르지 않은 동작을 고친 경우에 사용합니다.

      ADD -> 코드나 테스트, 예제, 문서 등의 추가 생성이 있을 때 사용합니다

      REMOVE -> 코드의 삭제가 있을 때 사용합니다. ‘Clean’이나 ‘Eliminate’를 사용하기도 합니다.

      IMPROVE -> 향상이 있을 때 사용합니다. 호환성, 테스트 커버리지, 성능, 검증 기능, 접근성 등 다양한 것들이 목적이 될 수 있습니다.

      IMPLEMENT -> 코드가 추가된 정도보다 더 주목할 만한 구현체를 완성시켰을 때 사용합니다.
      
      REFACTOR -> 코드 전면 수정이 있을 때 사용합니다.

      MOVE -> 코드의 이동이 있을 때 사용합니다.

      RENAME -> 이름 변경이 있을 때 사용합니다.
      
      UPDATE -> 개정이나 버전 업데이트가 있을 때 사용합니다. 주로 코드보다는 주로 문서나 리소스, 라이브러리등에 사용합니다.

 

 

두가지 버전 모두 간략하게 사용해봤는데 첫번째께 덜 복잡하고 편리하게 느껴져서 애용해야겠다고 생각했다.

 

 

제목은 50자를 넘기지 않고 대문자로 시작하며 서술어가 아닌 명사로 끝나야한다. 또한 마지막에 .(쩜) 과 같은 마침표를 찍지 않는다.

 

---

 

2. 본문내용(body)

1번까지만 써도 충분해서 여기서부터는 작성이 선택사항이다.

72자를 넘기지 않고 1번과 한줄을 띄워서 작성한다.

어떻게 변경하였는지 보다 무엇을, 왜 변경하였는지 설명한다.

 

 

---

 

3. 꼬리말(footer)

마찬가지로 잘 작성하지 않으며 이슈 트랙킹을 위해 ID 등을 참조할 때 사용한다. 

EX) #123, #이슈번호

 

 

 

 

 

 

 

 

댓글, 공감, 구독은 큰 힘이 됩니다. 감사합니다. !!!