Guide
좋은 커밋 메시지 작성 가이드
공개 GitHub 기록에서 가장 먼저 드러나는 것은 활동 횟수지만, 실무적으로 더 오래 남는 인상은 커밋 메시지 품질인 경우가 많습니다. 메시지가 좋아지면 프로젝트 흐름이 훨씬 선명하게 보입니다.
왜 중요한가요?
커밋 메시지는 “무엇을 바꿨는지”와 “왜 바꿨는지”를 가장 작은 단위로 남기는 기록입니다. 나중에 다시 읽는 본인에게도 중요하고, 외부에서 저장소를 볼 때도 작업 흐름을 이해하는 단서가 됩니다.
좋은 메시지의 기본 형태
fix: 검색 응답 오류 처리 보완feat: 결과 카드 이미지 저장 기능 추가refactor: GitHub API 요청 로직 분리
짧더라도 변경 목적이 드러나면 좋습니다. “update”, “test”, “수정”처럼 너무 넓은 말만 쓰면 맥락이 약해집니다.
피하면 좋은 예
수정업데이트커밋버그 잡음
나중에 기록을 다시 읽을 때 무엇이 달라졌는지 알기 어렵고, 공개 저장소 인상도 약해집니다.
실무적으로 더 좋아 보이게 만드는 법
- 한 커밋에는 한 가지 의도만 담기
- 기능 추가, 버그 수정, 문서 수정, 리팩터링을 가능한 한 분리하기
- 커밋 메시지에서 화면, API, 문서 중 무엇이 바뀌었는지 드러내기
- README나 배포 문서 수정도 별도 커밋으로 남기기