기타

Commit Convention 커밋 컨벤션

s.e.s 2024. 5. 22. 00:40

 

커밋 메시지 형식

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

type

  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, …)
  • refactor
  • test (when adding missing tests)
  • chore (maintain)

scope

  1. 어디가 변경되었는지
  2. 생략 가능
  3. $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView…
  4. 함수가 변경되었다면 함수 이름, 메소드가 추가되었다면 해당 클래스 이름 등

subject

  1. 명령문, 현재 시제
  2. 끝에 마침표 X
  3. 첫글자 소문자로 쓰기

body

  1. 명령문, 현재 시제 권장
  2. 변경한 이유, 변경 전과의 차이점 설명
  3. 무엇을 왜 했는지
  4. 생략 가능

footer

  1. 주요 변경 내역(breaking changes)
  2. 모든 주요 변경 내역이 변경점, 변경 사유, 마이그레이션 지시와 함께 언급
  3. 해결된 issue tracker ID 명시 (주로)
  4. 생략 가능

참고한 자료