• Docs Version

<aside> <img src="https://media.vlpt.us/images/hdy20201004/post/bd6d5947-ade2-4680-a74f-689d377c77a2/git_logo.png" alt="https://media.vlpt.us/images/hdy20201004/post/bd6d5947-ade2-4680-a74f-689d377c77a2/git_logo.png" width="40px" /> 좋은 커밋 메세지를 위해 지켜야 할 것을 정리한 Docs 입니다. ( 이후 경험에 비추어 내용을 수정해나갈 생각입니다. )

</aside>

프로젝트를 하면서 Git 사용을 많이 합니다. Git을 통해 버전관리와 협업을 효율적으로 할 수 있습니다.

좋은 Commit Message만으로 커밋 속 작업 내용을 직관적으로 알 수 있고, 이를 통해 프로젝트의 흐름을 쉽게 이해할 수 있을 것입니다.

좋은 Commit 메시지를 위해 노력해야하는 이유

1. 커밋 로그 가독성
2. 협업과 리뷰 프로세스
3. 쉬운 코드 유지보수

Commit Message 규칙

• 제목과 본문을 빈 행으로 구분한다.

  • 일반적으로 제목, 공백 한 칸, 본문으로 구성
  • 빈 행으로 구분했을때 가독성이 아주 높아진다.

• 제목을 50글자 내로 제한

  • 영어든, 한글이든 상황을 50글자이내로 요약해서 표현
  • 글자 수를 제한함으로써 더 읽기 좋은 Commit 제목을 만들 수 있다.
  • 같은 의미면 짧은게 낫다.

• 제목 첫글자는 대문자

  • update modal component ( X )
  • Update modal component ( O )

• 제목 마지막에 마침표( . ) 넣지 않기

  • Update modal component. ( X )
  • Update modal component ( O )

• 제목은 명령조로

  • 제목에 한해서 첫 단어를 동사원형으로 작성 ( 본문의 경우 평서문 )

  • git 스스로 자동 커밋을 작성할 때 명령문을 사용

    • 명령조로 작성함으로써 git의 빌트-인 컨벤션을 따른다는 것을 의미

    ( 아직까지는 잘 안와닿네요... )

• 본문을 영문기준 72자 마다 줄 바꾸기

  • 가독성을 위한 규칙
  • 72자 아니더라도 의미를 분리하기위해 적당한 위해서 줄을 바꾸는 것을 추천

• 본문은 어떻게 보다 무엇을, 왜에 맞추어 작성하기

  • 어떻게 보다 왜 바꿨고, 그전엔 어땠는지, 지금은 어떻게 작동하는지에 초점
    • 어떻게 작동하는지는 코드 주석을 활용하는 것이 좋다.