깃 커밋 메시지 컨벤션

1289 단어 githubgithub

메시지 구조


커밋 메시지는 제목(필수), 본문(선택), 꼬리말(선택)으로 구성되며, 각 파트는 빈줄로 구분한다.

type: Subject // 제목

body // 본문

footer // 꼬리말

type

type은 다음 중 하나로 구성된다.

  • feat : 새로운 기능
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우
  • refactor : production 코드 리팩토링
  • test : 테스트 추가, 테스트 리팩토링 등 production 코드 변경 x
  • chore : updating build tasks, 패키지 매니저 configs 등 production 코드 변경 x

subject

  • subject는 50자를 넘기지 않는다.
  • 대문자로 시작하며, 마침표를 찍지 않는다.
  • (영어의 경우) 현제 시제 명령조로 묘사한다.
    • ex) change(O), changed(X), changes(X)

Body

  • 커밋이 추가적인 설명이나 내용이 필요한 경우에만 작성한다.
  • '어떻게' 했는지가 아닌, '무엇을' '왜' 했는지에 대해 작성한다.
  • title, footer과 빈칸으로 구분한다.
  • 72자를 넘지 않는다.

Footer

  • issue tracker IDs을 참조하기 위해 선택적으로 사용한다.

참고자료


좋은 웹페이지 즐겨찾기