커밋 메시지는 제목이 아니다
원문은 Salvatore Sanfilippo님이 에 게재했습니다. 이 블로그 구독하기
따지고 보면 주제도 아니다. 누구나 커밋 메시지 첫 줄 끝에 마침표를 찍지 말라고 할 것이다. 나도 한동안 그 조언을 따랐지만 오늘부터는 그만두려 한다. 커밋 메시지는 제목이나 주제가 아니라고 생각하기 때문이다. 커밋 메시지는 커밋이 만든 변경의 의미를 요약한 것이므로 작은 문장이다. 그 문장은 커밋 메시지의 다음 줄에서 더 자세히 보충될 수 있지만, 많은 경우 본문은 *없다*, 첫 줄만 존재한다. 제목이나 주제만 있는 이메일이나 글을 얼마나 자주 보는가? 아마 거의 없을 것이다. 그래서 내게는 이렇게 느껴진다: 이것은 최대한 정보 밀도가 높은, 영리한 요약이다. 그리고 필요하면, 자세한 버전은 이렇게 이어진다: 1. 나는 이렇게 했다. 2. 그리고 결과는 이렇게 되었다. 3. 그리고 이렇게 하면 재현할 수 있다. 그래서 앞으로 또 끝에 마침표를 찍지 말라는 말을 들을 때마다 이 글을 링크할 것이다. 하지만 이건 단순히 마침표 하나의 문제가 아니다. 커밋 메시지의 첫 줄을 제목이라고 생각하면 글을 *쓰는 방식* 자체가 달라진다. 뒤에 이어질 내용을 위한 도입부 정도의 텍스트가 되어 버리고, 정보 밀도에 대한 고민은 사라진다. 코더는 코딩을 해야 하니까, 뭔가를 한 줄로 아주 짧게 말할 수 있다면 그렇게 하고, 추가 정보는 다음 줄에 남겨두어야 한다. “제목이니까”라는 이유로 첫 줄을 희생시키지 말고. 게다가 프로그래밍은 요약을 쓰는 예술이다. 그렇지 않으면 필요 이상으로 훨씬 복잡한 프로그램이 나오게 된다. 그러니 이것도 우리에게는 좋은 연습이 될 것이다.
글을 무작위로 읽기
댓글
로그인하고 댓글 남기기