본문 바로가기
IT 자료/git

커밋 메시지 컨벤션(Commit Message Convention)

by jissi 2019. 11. 7.

기본적인 구조

 

type : subject

본문(body)

꼬리말(footer)

 

Type

  • feat: 새로운 기능
  • fix: 버그 수정
  • docs: 문서 수정
  • style: 스타일 변경(코드변경x)
  • refactor: 리펙토링
  • test: a테스트 코드 추가, 테스트 리팩토링
  • chore: updating build tasks, package manager 설정

The Subject

Subjects는 50글자를 넘어가면 안되며, 첫 시작은 대문자로 해야하고 마지막에 마침표(.)를 찍으면 안된다

어떤변경점이 있는지 설명하며, 명령조를 사용해라(change O, changed, changes X)

The Body

Body부분은 선택사항이며, 부연설명이나 커밋의 이유를 설명할떄만 사용해야한다.

어떻게(how)가 아닌, 무엇을(what), 이유(why) 를 설명해야한다.

tile과 body는 1줄의 공백이 필요하며, body의 각 라인은 72글자를 넘어설 수 없다.

The Footer

footer 역시 선택사항이며 issue tracker IDs를 적을때 사용한다.

 

 

 

 

출저

https://meetup.toast.com/posts/106

https://udacity.github.io/git-styleguide/

댓글