Git 커밋 메시지 작성법 포스팅을 읽고
주위 사람들이 괜찮다고 추천한 포스팅을 읽고 몇 가지 적용해볼 수 있을 것 같아 기록해 둔다.
git의 커밋 메시지가 왜 중요한지는 다들 잘 알고 있을 것이다.
해당 글에서는 커밋 메시지가 중요한 이유를 요약해주고,
좋은 커밋 메시지를 위한 7가지 방법을 제시한다.
1. 제목과 본문을 빈 행으로 분리하라
GitHub의 커밋 뷰에서도 제목만 보이고 본문은 접혀 있어,
가독성과 구조화 측면에서 매우 중요하다.
Sourcetree나 GitKraken과 같은 툴에서는 기본적으로 이 포맷이 적용되어 있다.
2. 제목은 50자 이내로 제한하라
긴 제목은 읽기도 어렵고, CLI나 GitHub UI에서도 잘려 보이므로
간결하고 핵심적인 메시지를 쓰는 훈련이 된다.
3. 제목의 첫 글자는 대문자로 쓰라
단순하지만 시각적으로 정돈된 느낌을 주며
영문 커뮤니케이션의 기본적인 문법 중 하나다.
4. 제목 끝에 마침표를 쓰지 말라
개인 취향일 수 있지만, 많은 유명 프로젝트가 이를 따르고 있다.
5. 제목에는 명령문을 사용하라
예:
Fix bug when user clicks save✅Fixed bug...❌
Git이 자동 커밋 메시지를 생성할 때 명령문을 사용한다는 것도 근거 중 하나.
무엇보다 명령문이 더 명확하고 직관적이다.
6. 본문은 72자 단위로 개행하라
IDE에서는 불편하지 않지만 CLI나 Git log에서 긴 줄은 가독성이 떨어진다.
이 기준이 어디서 유래했는지는 명확치 않지만, 적절한 줄바꿈은 독자를 배려하는 기본 매너다.
7. "어떻게"보다 "무엇과 왜"를 써라
이 항목이 가장 중요하다고 느꼈다.
잘못된 예:
fix layout issue in nav(어떻게만 설명)
좋은 예:
Fix layout issue that broke on mobile devices
— the nav bar was misaligned due to flex config on small screens.
왜 그렇게 고쳤는지, 무엇이 문제였는지를 설명하는 것이 핵심.
추가 의견: 커맨드라인 vs IDE
글에서는 CLI를 추천하지만, 나는 IDE나 GUI 툴도 유용하다고 생각한다.
단, 원리를 이해하고 쓸 것.
툴을 맹신하는 것이 아니라, 이해한 상태에서 효율을 높이는 데 사용하는 것이 중요하다.
결론
커밋 메시지는 프로젝트의 역사다.
앞으로는 좀 더 신경 써서 작성해보자.