Skip to content

Commit Message Guide

soonchan Kwon edited this page Nov 11, 2020 · 1 revision

Commit message structure

type : subject

body

footer

Commit Type

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

Subject

  • 제목은 50자 이내, 대문자로 시작하며 마침표를 붙이지 않는다
    • feat : Update new function
  • 과거 시제를 사용하지 않고 명령어로 작성한다
    • "Fixed" → "Fix"
    • "Added" → "Add"

Body

  • 제목으로부터 한칸을 띄워 작성한다

footer

  • 꼭 작성할 필요는 없다
  • issue tracker id를 작성할 때 사용한다
feat : Update README

body body body

close #123

출처

Git - 커밋 메시지 컨벤션

Clone this wiki locally