커밋과 풀 리퀘 메세지가 모호하다는 지적을 받았다. 확실히 지금까지 내가 써온 메세지들을 다시 보니 개발한 사람만이 완벽히 이해할 수 있는 메세지들이었던 것 같다.

무엇보다도 코드의 수정이 자주 일어나는 협업 환경에서는 코드 하나하나를 다 분석하고 파악할 시간이 없다보니 이런 메세지로 확실히 이번 수정 사항이 어떻게 변경되었는지 나타내는 것이 정말 중요한 거 같다.

그래서 commit 메세지가 굉장히 자세한 예시와, 나름대로 깃헙 메세지를 잘 작성하는 법을 정리해두려고 한다.

예시) 리눅스 커밋로그 예시

위 예시를 보면

1. 대제목은 기능 요약
2. 소제목(부가설명)은 대제목에 대한 좀 더 구체적인 설명 등등
3. 그 밑에는 실제로 바뀐 파일들이나 부분들에 대한 구체적인 언급

형식으로 구성되어 있는 것을 볼 수 있었다.

나는 지금까지 기능 요약만 잘 해왔고, 세부적인 내용은 전혀 쓰지 않았던 것이 문제였던 것 같다.

+

추가로 나는 대제목을 쓸 때 가장 맨 앞에는 동사 원형이 올 수 있도록 작성하는 것이 좋은 방법이라고 생각한다. 예를 들어, Add, Revise, Delete 같은 것이 오게 작성하면 커밋 메세지의 딱 앞부분만 봐도 어떤 커밋인지 알 수 있다.