Git 좋은 커밋(Commit) 메세지 작성하기

Git 을 사용하는 개발자마다 Commit 형식을 다르게 사용하다보니, 통일성이 없고 가독성이 떨어진다.

효율적인 의사소통을 위하여 커밋 메세지를 작성하는 방법도 통일할 필요가 있다.

 

좋은 메시지 작성하기

• 동명사(~ing)보단 명사를 사용한다.
• 부정문을 사용한다.
• 관사(a, an, the)는 사용하지 않는다.

자주 사용하는 영문구

Fix 수정, 고치다

버그 등 기능상에 문제가 있거나 수정해야하는 부분이 있을때 주로 사용한다.

Fix A

• A 를 수정한다.

Fix A in B

• B 안의 A 를 수정한다.

Fix A witch B 또는 Fix A that B

• B 절의 A를 수정한다.

Fix incorrect type which makes animated gifs not loop forever on device
Fix crash that happens when a component throws an exception that contains a null message

Fix A 를 사용 할 수 있지만, 좀 더 많은 내용을 알려주고 싶을때 사용

Fix A to B, Fix A to be B

• B 를 위해 A 를 수정한다.

Fix A so that B

• A를 수정해서 B가 되었다.

Fix A where B

• B 처럼 발생하는 A를 수정한다.

Fix A when B

• B 일 때 발생하는 A를 수정한다.

ADD 추가

새로운 기능, 테스트 케이스 또는 문서에 추가 내용이 있는 경우 주로 사용한다.

Add A

A 를 추가한다.

Add A for B

B 를 위해 A 를 추가한다.

Add A to B

B 에 A를 추가한다.

Reference

• https://blog.ull.im/engineering/2019/03/10/logs-on-git.html