본문 바로가기
📙 Git

Clean Commit Message 를 작성해야 하는 이유

by GroovyArea 2022. 5. 3.
Git 을 이용해 프로젝트를 진행할 때는 항상 commit message를 적기 마련이다. 특히 협업에서는 메시지의 규칙과 구체화가 가히 그 역할이 필수적이라고 생각한다. 나 조차도 커밋 규칙을 모르고 내 입맛에 맞게 작성했던 경험이 많다. 이번 프로젝트를 진행하며 clean commit message 전략을 공부하며 적용시킬 계획이다. 

 

Commit이란?

- 의미 있는 변화 대해 기록하는 것이 바로 commit!

- 특정 시점에 변화에 대한 사항을 메시지와 함께 기록하는 포인트

 

특정 시점이란?

- 작은 변화, 큰 변화인지 경계가 모호

- 커밋 메시지가 간단할 수록 기능을 세세하게 나눈 것이기 때문에 리뷰도 쉽고 다른 사람이 쉽게 이해가 가능하다고 생각하기 때문에 작은 커밋이 좋다고 생각한다.

 

Clean Commit Message

  • 훗날 다시 봐도 쉽게 떠오르는 메시지
  • 간결한 메시지
  • 디테일한 메시지 등등

 

Clean Commit Message를 작성하기 위한 7개의 규칙

  1. 제목과 본문을 한 줄 띄어 분리하기
  2. 제목은 영문 기준 50자 이내로
  3. 제목 첫글자를 대문자로
  4. 제목 끝에 [ . ] 금지
  5. 제목은 명령조로
  6. 본문은 영문 기준 72자마다 줄 바꿈
  7. 본문은 어떻게 보다 무엇을 , 왜 에 맞춰 작성

=> 나 같은 경우는 굳이 영문을 이용하기 보다 간결한 한글 커밋 메시지를 작성할 계획이다. 회사에 들어가서 일을 하게 되면 회사에 맞는 커밋 규칙을 새로 공부하자는 생각을 했다.

반응형

'📙 Git' 카테고리의 다른 글

PR을 작성하는 좋은 방법  (0) 2022.05.03
Git Flow 란 무엇일까?  (0) 2022.05.03