Git 커밋 메시지 컨벤션

1. 설명

• 모든 commit message는 <타입>[적용 범위(선택 사항)]: <설명> 를 포함해야합니다.
• 커밋 메시지 타입
  • feat
    • (new feature)
    • 새로운 기능
  • fix
    • (bug fix)
    • 버그 수정
  • docs
    • (changes to documentation)
    • documentation 변경
  • style
    • (formatting, missing semi colons, etc; no code change)
    • 코드 의미에 영향을 주지 않는 변경사항 ( white space, formatting, colons )
  • refactor
    • (refactoring production code)
    • 버그를 수정하거나 기능을 추가하지 않는 코드 변경, 리팩토링
  • test
    • (adding missing tests, refactoring tests; no production code change)
    • 누락된 테스트 추가 또는 기존 테스트 수정
  • chore
    • (updating grunt tasks etc; no production code change)
    • 패키지 매니저 설정할 경우, 코드 수정 없이 설정을 변경

• 단절적 변경에 대해 꼬리말로 설명할 경우 대문자 문자열 BREAKING CHANGE과 뒤따르는 콜론(:), 공백, 그리고 설명으로 구성되어야 합니다
  • ex) BREAKING CHANGE: api 스펙변경으로 인해 api/v2 설정값에 대해 보장하지 않습니다.

 

 

2. 예시

• commit message 예시
  • feat: 유저 전체 조회 기능 추가
  • fix!: update시 파라미터 수정
  • BREAKING CHANGE: deviceId 변수는 더 이상 사용되지 않습니다.

 

 

---

참고자료

• (링크)