좋은 Git Commit 메세지 작성

해당 게시글은 Commit Message에 대해 작성하였습니다.

팀 혹은 회사마다 Rule이 존재하기에 참고 자료로 활용 권장

좋은 Git Commit란?

Git 버전 관리에 있어서 Clean Code도 중요하지만

Commit Message 어떻게 작성할지도 중요하다.

 

 

취업/채용에 있어서도

대부분 IT 기업이 Git 주소를 요구하며

기술 면접관은 Commit 단위를 분석하기도 한다.

---

개발자가 어떤 "단위"로 개발을 하였는지, 

다른 사람에게 어떤 내용을 전달하고 리뷰 받고 싶은지 담는 것

 

 

예를들어, git commit 제목은 동사부터 시작하며

주로 사용하는 동사: add, fix, modify, remove/delete

내용에는 주어 + 동사로 주로 시작

* 팀 혹은 회사마다 Rule이 존재하기에 참고 자료로 권장

 

 

본인만 알아볼 수 있도록 작성해서는 안되며

다른 사람은 물론 훗날 본인이 다시 코드를 리뷰할 수 있기에

"History" 잘 남겨놓아야 한다.

 

Which is better?

① 무엇을 했는지 간단 명료하게 작성한다.

- 첫번째 줄에서는 무엇을 했는지 한 눈에 알아볼 수 있게 작성한다.

- Committer의 의도 파악할 수 있어야 한다.

- 불필요한 미사여구 배제

 

 

② 첫 문자는 대문자로 작성

- 첫 문자를 대문자로 작성하게 되면 훨씬 보기 편하다.

 

 

③ 첫 줄에는 마침표를 찍지 않는다.

- 이메일 제목에 마침표를 하지 않듯이

　Commit Message 제목(첫번째 줄)에도 마침표를 하지 않는다.

 

 

④ 첫 줄은 50자, 그 밑의 줄부터는 70자 내로 작성한다.

- 두 번째 줄은 제목과 설명 부분을 나누기 위해서 비워둔다.

- 세 번째 줄부터는 무엇을 했는지 구체적으로 자세하게 적는다.

 

[까망] Git 목록