Git) 좋은 git commit 메시지란 무엇일까?

 

그 동안 팀 프로젝트를 진행하면서 많은 개발자들의 git commit 메시지를 봐왔습니다. 

누구는 한글로 메시지를 남기기도 했고, 누구는 영어로 짧게 혹은 길게 남겼습니다. 

저 또한 그들의 메시지를 남기는 방식을 참초하며 영향을 받았고, 이런식으로 메시지를 남기는 것이

가독성이 더 좋을 것 같다는 생각을 했습니다.

그럼 좋은 git commit 메시지라는 것에 정답이 있을까? 라고 생각이 들었습니다.

---

결론 부터 말하자면 정답은 없습니다. 하지만 개발자들이 선호하고 좋은 커밋 메시지라고 약속하고 있는 것은 있습니다.

 

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속

1. 제목과 본문을 한 줄 띄워 분리하기
2. 제목은 영문 기준 50자 이내로
3. 제목 첫글자를 대문자로
4. 제목 끝에 . 금지
5. 제목은 명령조로
6. 본문은 영문 기준 72자마다 줄 바꾸기
7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

• 아까 말씀드렸듯이 정답은 없습니다. 하지만 3,4,5 번은 지켜주시는 것이 좋습니다.
• 그 이유는 저 내용들은 영어 문법에 관련된 내용들이기 때문입니다.

---

 

• 위의 커밋은 예전에 제가 커밋 메시지를 날렸던 방식입니다. "어떤 기능을 수정했다" 라는 의미로 해석은 할 수 있습니다.
• 하지만 좋은 git 커밋 메시지와는 거리가 있고, 또한 상세한 기능 개발에 있어 이러한 짧은 메시지는 협업에 있어 가독성이 떨어진다고 생각됩니다.

 

 

• Git에서 어떤 명령을 했을 실행했을 때 자동으로 생성되는 메시지들을 보면 위처럼 생성이 됩니다.
• 좋은 git 커밋 메시지의 약속과 상응되는 메시지라 생각이 됩니다.

 

---

좋은 git 커밋 메시지를 위한 약속을 지킨다면 가독성과 유지보수를 편하게, 그리고 더 나은 협업을 할 수 있을 것 같습니다.

 

References

좋은 git 커밋 메시지

git commit message