커밋 메세지를 작성하다 보면 어떻게 작성하는 것이 좋은 커밋 메세지인가를 고민하고 찾아볼 때가 많이 있다. 좋은 커밋 메세지를 작성하는 방법에 대해서 이번 포스팅에서 정리 해보려고 한다.
필요성
협동 프로젝트에서 작성된 코드를 리뷰하는 것은 필수사항이다. 하지만 남이 작성한 코드를 읽는 것은 쉽지 않다. 심지어 내가 작성한 코드도 조금만 시간이 지나면 금방 잊어버리고 이해하기 힘든 부분도 있다. 커밋 메세지는 이 코드가 무엇을 의미하는지에 대한 내용이 담겨있다. 명시적이고 의미있게 커밋 메세지를 작성해두면 다른 사람 혹은 미래의 내가 특정 부분의 코드에 대한 맥락을 파악하는데 큰 도움을 줄 것이다.
3가지 목적
- 리뷰 프로세스를 빠르게 만든다.
- 좋은 릴리즈 노트를 작성하도록 해준다.
- 수년 후에 그 코드를 다시 봤을 때 왜 그 기능이 추가됐는지, 왜 그 코드를 변경했는지 알 수 있도록 해준다.
작성법
1-1. 명령조로 작성
1-2. 첫 문자는 대문자
1-3. 과거형은 지양
예시
- Resolve conflict
- Change file
- Fix error
2-1. 첫 줄은 50자 이내, 나머지 줄은 70자 이내
2-2. 두 번째 줄은 비움
2-3. 나머지 줄은 자세히
예시
변경에 대한 짧은 요약(50자 이내, 마침표를 찍지 않는다)
더 구체적인 설명은 이 곳에 작성한다. (행 당 70자 이내)
이메일을 작성할 때 처럼 첫줄에는 제목, 나머지 공간에는 본문을 작성하는 형태이다.
- 이런식으로도 작성한다. 사이사이에는 빈 공간을 둔다.
- 블릿(bullet)으로 하이픈(-)이나 별표(*)를 사용한다.