GN⁺: 나의 가장 좋아하는 Git 커밋 (2019)

나의 가장 좋아하는 Git 커밋

• Git 커밋 메시지의 중요성을 강조하며, 코드베이스를 문서화하는 데 있어 가장 강력한 도구 중 하나라고 생각함.
• 개발자 Dan Carley가 작성한 "Convert template to US-ASCII to fix error"라는 커밋을 예로 들어 그 이유를 설명함.
• GDS(Government Digital Service)에서의 경험을 바탕으로, 공개적으로 코딩하는 것의 이점 중 하나는 조직 외부에서도 이러한 예를 공유할 수 있다는 점임.

이 커밋이 좋은 이유

• 커밋 메시지와 코드 변경 사항의 비율이 재미있지만, 그것이 공유할 가치가 있다고 생각하는 이유는 아님.
• 다른 조직이나 개발자였다면 이 커밋 메시지는 단순히 change whitespace 또는 fix bug로 요약될 수 있었을 것임.
• 대신, Dan은 주변 사람들을 위해 정말 유용한 커밋 메시지를 만드는 데 시간을 할애했음.

변경 사유를 설명함

• 최고의 커밋 메시지는 변경한 무엇뿐만 아니라 왜 변경했는지를 설명함.
• 이 커밋에서는 /etc/nginx/router_routes.conf의 내용을 일치시키기 위해 도입된 테스트가 bundle exec rake로 실행될 때 ArgumentError: invalid byte sequence in US-ASCII 오류로 실패한 이유를 자세히 설명함.
• 이러한 정보는 문서화하기에 매우 가치가 있으며, 사람들이 원래의 맥락을 잊거나 다른 팀으로 옮겨가고 조직을 떠나면서 쉽게 잃어버릴 수 있음.

검색 가능함

• 커밋 메시지의 첫 부분에는 변경을 유발한 오류 메시지가 있어, 누구든지 코드베이스에서 git log --grep "invalid byte sequence"를 실행하거나 GitHub의 커밋 검색을 사용하여 이 오류를 검색할 수 있음.
• 실제로 여러 사람들이 이 문제를 검색하고, 이전에 누가 이 문제를 발견했는지, 어떻게 대처했는지를 알아낼 수 있었음.

이야기를 전달함

• 커밋 메시지는 문제가 어떻게 보였는지, 조사 과정이 어떠했는지, 해결 과정이 어떠했는지에 대한 상세한 내용을 담고 있음.
• 커밋 메시지는 특정 파일이나 함수, 코드 라인을 문서화하는 것이 아니라, 코드베이스가 겪은 여정에 대한 추가 정보를 문서화하는 데 매우 적합함.

모두를 조금 더 똑똑하게 만듦

• Dan이 각 단계에서 실행한 명령어를 문서화한 것은 팀 내 지식을 공유하는 가벼운 방법이 될 수 있음.
• 이 커밋 메시지를 읽음으로써, 누군가는 Unix 도구 세트에 대한 몇 가지 유용한 팁을 배울 수 있음.
• 이 변경 사항을 검토하는 사람이나 나중에 이 커밋을 찾는 사람 모두 이러한 것들을 배울 수 있음.

연민과 신뢰를 구축함

• 마지막 단락은 인간적인 맥락을 추가함.
• 이 말을 읽으면, Dan이 교묘한 버그를 추적하는 데 한 시간을 소비한 것에 대한 좌절감과 해결한 것에 대한 만족감을 느낄 수 있음.
• 이러한 커밋 메시지는 모든 변경 사항 뒤에 최선의 결정을 내린 인간이 있다는 것을 기억하는 데 도움이 됨.

좋은 커밋의 중요성

• 이 예는 극단적인 경우이며, 모든 커밋이 이 정도의 세부 사항을 가질 것으로 기대하지는 않음.
• 그러나 이는 변경 사항 뒤에 있는 맥락을 설명하고, 다른 사람들이 배울 수 있도록 돕고, 코드베이스에 대한 팀의 집단적인 정신 모델에 기여하는 훌륭한 예임.
• 좋은 커밋 메시지의 이점과 그것을 더 쉽게 구조화하는 데 도움이 되는 도구에 대해 더 알고 싶다면 Joel Chippindale의 "Telling stories through your commits"와 Tekin Süleyman의 "A branch in time"을 추천함.

GN⁺의 의견

• 이 기사는 Git 커밋 메시지의 중요성을 강조하며, 코드베이스의 역사를 문서화하고 지식을 공유하는 데 있어 커밋 메시지가 얼마나 강력한 도구가 될 수 있는지를 보여줌.
• Dan Carley의 커밋 메시지는 변경 사유, 검색 가능성, 이야기 전달, 지식 공유, 연민과 신뢰 구축 등 여러 가지 면에서 모범적인 사례를 제시함.
• 좋은 커밋 메시지 작성의 중요성을 이해하고 실천함으로써, 개발자들은 더 나은 협업과 코드 유지 관리를 경험할 수 있으며, 이는 전체 팀의 생산성과 효율성을 향상시키는 데 기여할 수 있음.