Git

Git Commit Message 작성 규칙

wsstar 2022. 9. 19. 10:50
728x90
반응형

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

  • 더 좋은 커밋 로그 가독성
  • 더 나은 협업과 리뷰 프로세스
  • 더 쉬운 코드 유지보수

좋은 commit message 의 기준은 다르나 누구나 봤을때 한눈에 수정내용에 대해 알아볼수 있는 commit message 가 가장 좋다고 생각한다...

 

좋은 Commit Message 를 작성 하기위한 규칙 

  • 제목과 본문을 빈 행으로 구분한다
  • 제목을 50글자 내로 제한
  • 제목 첫 글자는 대문자로 작성
  • 제목 끝에 마침표 넣지 않기
  • 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
  • 본문의 각 행은 72글자 내로 제한
  • 어떻게 보다는 무엇과 왜를 설명한다

 

 

참고 자료 :

https://jason-api.tistory.com/89

https://meetup.toast.com/posts/106

 

728x90
반응형