commit/commit message 작성 시 주의 사항

개요

커밋 시, 또는 커밋 메세지 작성시 지키면 좋은 컨벤션을 이해한대로 정리한 글.

1. 커밋 시 주의사항
2. 커밋 메세지 컨벤션

커밋 시 주의사항

• 1커밋, 1수정사항
  다양하게 수정을 하고나서 하나의 커밋으로 남기는 것은 좋지 않다. 하나의 커밋이 하나의 사실만을 갖고 있어야 나중에 이해하기 쉽고, 커밋 메세지 작성시에도 용이하다.
  
• 커밋의 결과는 항상 실행가능해야 한다.
  현재 프로젝트 디렉토리의 상태가 그 내부의 전체 코드를 실행했을 때 에러가 발생하지 않는 상태인 경우에만 커밋을 해야한다. 나중에 동료 개발자가 특정 커밋의 코드로 실행했을 때 에러가 발생한다면 혼란을 줄 수 있다.
  

커밋 메세지 컨벤션

• 커밋 메세지 구성 : 제목 + 설명(선택) + 꼬릿말(선택)
  각 구성 요소는 한 줄씩 띄워서 구분한다.
  • 제목 : feat, fix, style, docs, comment 등의 tag와 간결한 명령조 설명을 함께 사용.
  • 설명 : 어떤 문제가 있어서 왜 고쳤고 이 해결책이 어떤 효과를 가지는지— 최대한 상세하고 친절하게
  • 꼬릿말 : 이슈 트래커 ID등의 부가 정보 (실무에선 발생하는 이슈들의 추적을 위해 ID를 다나보다…)
• 작성 예시

  Feat: 회원 가입 기능 구현
  
  SMS, 이메일 중복확인 API 개발
  
  Resolves: #123
  Ref: #456
  Related to: #48, #45

  Fix: 버그 수정
  
  Fix typo in style.css

참고 자료

• 커밋 메세지 작성 경험이 부족해 예시는 다른 분의 블로그 글을 참조하였습니다.

  [Git] Commit Message Convention