좋은 commit message란 무엇일까

우리는 github를 통해서 협업을 하고 작업한 내용에 대한 commit message를 남긴다.

이때, 협업 시 좋은 commit message가 무엇인지 알아보았다.

 

1. commit message가 왜 중요한가

• 코드 리뷰 시간을 단축하여 능률적으로 처리할 수 있다.
• 변경 사항을 이해하는 데 시간을 단축할 수 있다.
• 코드만으로 설명하기 어려운 "왜 이렇게 구현했을까?"를 설명할 수 있다

 

2. 좋은 commit message 작성하기

1️⃣ 명령조

• 좋은 예

Use InventoryBackendPool to retrieve inventory backend

 

• 나쁜 예

Used InventoryBackendPool to retrieve inventory backend

 

왜 명령조를 사용할까? commit message는 변경사항만 알리는 것이 아니라, 변경사항이 실질적으로 어떤 일을 하는지 설명한다.

 

2️⃣ 첫 번째 문자를 대문자로 시작하기

• 좋은 예

Add `use` method to Credit model

• 나쁜 예

add `use` method to Credit model

 

첫 문자를 대문자로 작성해야 하는 것은 문장의 시작에 대문자를 사용하는 문법을 지키기 위한 것이다. 

 

3️⃣ 소스코드를 보지 않아도 변경 사항을 알리기

• 좋은 예

Add `use` method to Credit model

• 나쁜 예

Add `use` method

 

많은 사람들이 참여하는 프로젝트에서 수정 사항을 일일이 확인할 때 commit message가 명확하면 훨씬 코드리뷰가 쉬울 것이다.

 

4️⃣ 맥락없는 메세지 사용 자제하기

Fix this

Fix Stuff

Change stuff

Adjust CSS

 

이렇게 작성해놓으면 어딜 고쳤는지, CSS에 어느 부분이 수정되었는지 전혀 알 수 없다.

 

5️⃣ 일정한 언어 사용하기

Credit에 use 메소드 추가
Use InventoryBackendPool to retrieve inventory backend
use 기능 작동되는지 테스트

 

가끔씩 급할 때 영어가 생각나지 않으면 한국어로 메세지를 쓰는 경우가 있다. 그러나 영어와 한국어를 혼용해서 쓰면 일관성이 없다.

 

 

---

 

추가로, 커밋 메세지를 남길 때 보통 type:내용 식으로 쓰는 경우가 많다. 아래 내용은 type에 대한 설명이다.

타입 이름내용

feat	새로운 기능에 대한 커밋
fix	버그 수정에 대한 커밋
build	빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋
chore	그 외 자잘한 수정에 대한 커밋
ci	ci 관련 설정 수정에 대한 커밋
docs	문서 수정에 대한 커밋
style	코드 스타일 혹은 포맷 등에 관한 커밋
refactor	코드 리팩토링에 대한 커밋
test	테스트 코드 수정에 대한 커밋
perf	성능 개선에 대한 커밋

 

 

참고

https://cbea.ms/git-commit/