좋은 Git Commit 메세지 작성

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

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

좋은 Git Commit란?

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

다른 사람에게 어떤 내용을 전달하고 리뷰 받고 하고 싶은지가 담겨 있다.

채용에 있어서도 대부분 IT 기업이 Git 주소를 요구하며, 이때 기술 면접관은 Commit 단위를 분석하기도 한다.

 

그렇기에 Commit Message를 작성할 때 본인만 알아볼 수 있도록 작성해서는 안되며

다른사람은 물론 훗날 자기자신이 다시 코드를 리뷰할 수 있기에 "History" 잘 남겨놓아야 한다.

 

Commit Message 전체적인 모양은 회사 혹은 팀마다 정해진 Rule이 존재한다.

ex) 제목에 브랜치명으로 시작해서 한 줄 요약

하지만 어떤 내용을 기재할 것인지는 개발자 본인의 몫이다.

 

Which is better?

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

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

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

- 불필요한 미사여구 배제

 

② 첫 문자는 대문자로 작성

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

 

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

- 이메일 제목에 마침표를 하지 않듯이,  Commit Message 제목(첫번째 줄)에도 마침표를 하지 않는다.

 

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

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

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

 

[까망] Git 목록