장난감들
[Git] 올바른 Commit 메세지를 작성하는 방법
헤르메스의날개
2021. 1. 24. 18:00
728x90
사실 Comment는 프로젝트를 진행하는 동안 중요한 내용 중 한 가지입니다. 하지만 대부분 그 의미를 이해하지 못하고 시간에 급급한 나머지 적당히 Comment를 남기거나, 그냥 공백으로 Commit을 날려버리는 경우가 대부분이죠.
그러던 중 잘 정리된 내용을 발견하고 감명받아 옮깁니다.
Git 커밋 메시지 작성법 - 이상한모임
프로젝트가 지루하게 늘어지면, 커밋 메시지는 점점 더 무의미해진다.
blog.weirdx.io
훌륭한 Git 커밋 메시지의 일곱 가지 규칙
- 제목과 본문을 빈 행으로 분리한다
- 제목 행을 50자로 제한한다
- 제목 행 첫 글자는 대문자로 쓴다
- 제목 행 끝에 마침표를 넣지 않는다
- 제목 행에 명령문을 사용한다
- 본문을 72자 단위로 개행한다
- 어떻게 보다는 무엇과 왜를 설명한다
우리나라의 프로젝트 내용과 좀 무관한 내용이 있기는 합니다. 예를 들어 "3. 제목 행 첫 글자는 대문자로 쓴다"는 영어 위주의 규칙이지만, 본문의 내용을 읽어보면 의미 있는 내용이 있습니다.
한 번쯤 읽어보고 의미를 되새길 필요가 있습니다.
이 규칙의 의미를 되새겨보면...
거의 소스파일 하나하나 단위로 commit을 해야 함을 알 수 있습니다.
사실 SI에서 일을 하다 보면, 우리는 많은 일들을 한꺼번에 처리하고, 한꺼번에 정리하는 경향이 많아서 그 실효성이 좀 의심스럽긴 하군요.
728x90