🪄 클린코드? 클린 커밋 메세지!

클린 코드를 짜는 것 만큼, 클린 커밋 메세지를 남기는 것도 중요하다!

다들 클린 코드는 신경을 쓰고 있지만, 클린 커밋 메세지를 남기는 것에는 신경을 많이 쓰지 않고 있다.

❓ 우선 클린 코드는 어떤 코드인가?

• 결합도는 낮고 응집도는 높은 객체지향적인 코드
• 짧고 간결한 코드
• 가독성이 좋은 코드
• 더 이상 고칠게 없는 코드
• 중복이 없는 코드
• 테스트가 많은 코드

❓ 그럼 클린 커밋 메세지는 뭘까?

• 다시봐도 한 눈에 들어오는 간결한 메세지
• 하지만 모든 내용을 담고 있는 메세지

위 조건을 충분히 만족시키지는 어렵지만, 간단한 규칙을 정하면 충분히 클린 커밋 메세지를 남길 수 있다.

---

✒️ git commit 컨벤션 설정하기

만약 팀 프로젝트이든, 개인 프로젝트이든 시작하기 전에 각자의 커밋 메세지 남기는 규칙을 정해야한다. 개인 프로젝트의 경우에는 차후 버그 수정 및 과거 코드 이력을 쉽게 찾을 수 있기 위해 남겨야하지만, 팀 프로젝트의 경우에는 각자 기능별로 브랜치를 나눠 코딩하는 경우가 많기 때문에, 커밋 메세지를 반드시 자세히 남겨야 한다. 그래서 팀에 맞는 커밋 메세지 룰을 정한 후 프로젝트를 시작해야 한다.

---

📋 git commit 메세지 기본 규칙

• 제목과 본문은 줄로 분리해서 구분한다.
• 제목은 최대한 간결해야한다.
• 제목 끝에 마침표(.)는 넣지 않는다.
• 커밋 메세지는 항상 명령문으로 넣는다.
• 본문은 How(어떻게) 보다 What(무엇을),Why(왜) 위주로 작성한다.
• 동명사보다 명사를 사용한다.
  - 동사를 명사화시키기 보다는 그 의미를 잘 표현하는 명사를 찾아서 사용한다. 그렇게 되면 문장이 장황하지 않고 간결해진다.
• 관사는 사용하지 않는다.
  - 꼭 필요한 경우가 아니면 a, an, the는 사용하지 않습니다.
• 부정문 Don't를 사용한다.
  - 커밋 메시지를 명령문 형태로 써야 한다는 것은 모두들 알고 있지만, 부정 명령문을 사용하는 것은 잘 모릅니다. ‘A를 사용해’라고 명령했으니 반대를 이야기 할 때는 ‘A를 사용하지마’로 표현해야 합니다. Not use가 아니라 Don’t use 입니다.
• 오타 수정은 Correct misspelled text가 아닙니다.
  - 그냥 Fix typo라고만 하면 됩니다.