Git Commit Message Conventions 번역 글

이러한 규칙은 AngularJS 커밋 규칙에서 채택되었다.

 

커밋 메세지 형식

커밋 메시지의 모든 줄은 100자를 넘으면 안된다.

 

제목(Subject line)

• 변경 사항에 대한 간결한 설명
• 허용 타입(type)
  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, ...)
  • refactor
  • test (when adding missing tests) 누락된 테스트 추가할 때 + 테스트 추가
  • chore (maintain) 빌드 테스트 업데이트 , 패키지 매니저를 설정하는 경우(프로덕션 코드 변경은 X)
• 명령형, 현재 시제 사용
• 첫 글자를 대문자로 쓰지 않는다
• 끝에 점(.) 없음
• scope
  • 커밋 변경 위치를 지정하는 모든 것이 될 수 있다 
  • 예를들면, $browser, $compile, $location, $rootScope 등

 

본문(Body line)

• 명령형, 현재 시제 사용
• 변화에 대한 동기와 이전 행동과의 대조를 포함시킨다

 

바닥글(message footer)

• 중요한 변경사항은 바닥글에 변경 설명, 정당성 및 마이그레이션을 참고 사항과 함께 언급해야 한다
• 참조할 이슈가 있다면 이때 쓰면 된다. 단, 이미 닫힌 해결된 버그에 대한 이슈이면 다음과 같이 언급할 것
  • text Closes #234
  • text Closes #123, #245, #992

 

예시

한글버전(사실 현업에서 한글로 쓸 일이 없을 것이다)

영어 버전

 

 

출처 글 : https://gist.github.com/stephenparish/9941e89d80e2bc58a153#referencing-issues