아래의 가이드라인은 회사마다 다를 수 있으며, 절대적인 규칙이 있는 것도 아니지만
- 나중에 다시 봤을 때 이하하는데 어려움이 없도록
- 다른 동료 개발자와 협업하는 데 방해가 되지 않도록
커밋을 남기고, 그때마다 커밋 메시지를 잘 작성하는 것이 중요합니다.
1. 커밋 메시지 작성 가이드라인
1) 커밋 메시지의 제목(title)과 상세 설명(body) 사이에는 한 줄을 비워두세요.
*참고: Git 공식 권장사항 중) 필수는 아니지만 커밋 메시지를 변경 사항을 요약하는 짧은(최대 50자) 한 줄로 시작하고, 그 뒤에 빈 줄을 넣은 다음 더 자세한 설명을 넣는 것이 좋습니다. 커밋 메시지의 첫 번째 빈 줄까지의 텍스트는 커밋 제목으로 처리되고, 이 제목은 Git 전체에서 사용됩니다. 예를 들어, git-format-patch[1]는 커밋을 이메일로 바꾸고 제목을 제목 줄에 사용하고 나머지 커밋은 본문에 사용합니다. (링크)
2) 커밋 메시지의 제목 뒤에 온점(.)을 붙이지 마세요.
3) 커밋 메시지의 제목의 첫 번째 알파벳은 대문자로 작성하세요.
4) 커밋 메시지의 제목은 명령조로 작성하시오. (Fix it / Fixed it / Fixes it)
5) 커밋의 상세 내용에는 아래의 내용을 포함해주세요.
- 왜 커밋을 했는지
- 어떤 문제가 있었고
- 적용한 해결책이 어떤 효과를 가지는지
6) 다른 사람들이 자신의 코드를 바로 이해할 수 있다고 가정하지 말고 최대한 친절하게 작성하세요.
2. 커밋할 때 알아야할 가이드라인
1) 하나의 커밋에는 하나의 수정사항, 하나의 이슈(issue)를 해결한 내용만 남기도록 하세요. 다양하게 수정을 하고 나서 하나의 커밋으로 남기는 것은 좋지 않습니다. 하나의 커밋이 하나의 사실만을 갖고 있어야 나중에 이해하기 쉽습니다.
즉, 최대한 작은 단위의 변화를 기준으로 커밋하세요.
2) 현재 프로젝트 디렉토리의 상태가 그 내부의 전체 코드를 실행했을 때 에러가 발생하지 않는 상태인 경우에만 커밋을 하도록 하세요. 나중에 동료 개발자가 특정 커밋의 코드로 실행했을 때 에러가 발생한다면 혼란을 줄 수 있습니다.
커밋으로 보관된 특정 시점의 전체 코드는 항상 문제없이 실행되는 상태여야 합니다. 과거의 커밋이라도
- 과거 버전의 프로그램을 사용해야 하거나
- 과거 커밋을 시작점으로 한 다른 방향의 별도 프로젝트를 시작하거나
- 아예 그 커밋으로 현재 프로젝트를 리셋할 수도 있습니다.