[git] commit message 를 잘 작성하는 방법

새로운 회사에 입사하고, 깃의 새로운 커밋 컨벤션에 적응하느라 애를 썼다.

그래도 팀에서 정해진 컨벤션을 지키며 개발하니, 내가 어떤 내용에 대한 개발을 할지 명확하게 구분이 가능하고, 또한 동료의 산출물을 리뷰하는데에도 큰 도움이 됐다.

 

오늘은 그래서 깃 커밋 메시지에 대해 정리를 해두려한다.

 

커밋 메시지를 잘 써야하는 이유

1. 일관적이고 명확한 내용이 들어간 커밋 메시지는 다른 개발자가 산출물을 더 잘 이해할 수 있도록 돕는다.

2. 잘 작성된 커밋 메시지는 코드에서 문제가 발생했을 때, 더 쉽고 편하게 디버깅이 가능하게 한다.

3. 잘 작성된 커밋 메시지는  프로젝트의 맥락을 이해하는데 도움을 준다. 즉 해당 프로젝트에서 함께 작업하는 다른 개발자와 본인에게 변경 사항에 대한 컨텍스트를 전달한다.

 

좋은 커밋 메시지를 작성하는 방법

1. 제목에 어떤 내용을 담은 커밋인지 커밋 유형을 알 수 있도록 제목을 설정한다.

2. 누구나 어떤 내용인지 쉽게 파악할 수 있도록 자세하고 꼼꼼하게 commit body 를 작성한다. ( 커밋 메시지만 봐도 어떤 개발을 진행했는지 알 수 있도록)

3. 커밋메시지는 명령어 혹은 요청하는 어조를 사용한다.

4. 불필요한 구두점은 제거한다.

5. 팀에서 정의한 커밋 컨벤션을 완벽하게 지킨다.

 

끝