10.2: 커밋 메시지 잘 작성하기

본 문서는 Git Notes for Professionals (라이센스:CC-BY-SA) 를 한글로 번역한 문서입니다. 번역상 오류가 있을 수 있으므로 정확한 내용은 원본 문서를 참고하세요.

Section 10.2: 커밋 메시지 잘 작성하기

git log 내역을 살펴보는 사람에게 있어, 각각의 커밋의 목적이나 내용을 쉽게 파악할 수 있는지의 여부는 굉장히 중요하다.

좋은 커밋 메시지는 일반적으로 작업 (task) 이나 문제점 (issue) 관리 시스템상의 번호와 함께 무엇을 어떤 이유로, 어떻게 작업하였는지에 대한 간략한 설명을 포함하게 된다.

다음과 같은 메시지들은 좋은 커밋 메시지의 한 예라고 할 수 있다:

TASK-123: Implement login through OAuth
TASK-124: Add auto minification of JS/CSS files
TASK-125: Fix minifier error when name > 200 chars

반면에, 아래와 같은 메시지들은 그다지 유용한 정보를 포함하고 있지 않다:

fix // 무엇을 고쳤는가?
just a bit of a change // 무엇을 변경하였는가?
TASK-371 // 다른 설명이 전혀 포함되어 있지 않아, 직접 이슈 관리 시스템을 확인해 보아야 커밋 내용에 대한 정보를 얻을 수 있다
Implemented IFoo in IBar // 이러한 수정사항이 왜 필요한가?

커밋 메시지가 적절한 방향으로 작성되었는지를 판단할 수 있는 한가지 방법으로는 아래 문장의 밑줄 부분에 작성한 커밋 메시지를 대입 가능한지 확인해 보는 것이다:

If I add this commit, I will ___ to my repository.

훌륭한 커밋 메시지를 작성하기 위한 7가지 규칙

1. 주제를 기술한 라인과 본문을 작성한 부분 사이에 빈 줄을 하나 배치하여 두 부분을 분리시킨다
2. 주제 기술 라인의 내용이 50자를 넘지 않도록 한다
3. 주제 기술 라인의 첫 글자는 대문자로 표시한다
4. 주제 기술 라인의 끝에 마침표를 찍지 않는다
5. 주제 기술 라인은 명령법 (imperative mood) 을 사용하여 작성한다
6. 본문의 각 라인의 내용은 72자를 기준으로 개행하도록 한다
7. 본문에 기술하는 내용은 "어떻게" 보다는 "무엇을" "왜" 작업하였는지에 초점을 맞추도록 한다

Chris Beam의 블로그의 7가지 규칙 에서 발췌함.

[출처] https://books.goalkicker.com/GitBook/ (CC BY-SA)