Git Commit Message Convention

Commit Message Convention

Message Structure

기본적으로 Commit Message는 아래와 같이 제목/본문/꼬리말로 구성한다.

type : subject

body

footer

The Type

• Feat: 새로운 기능 추가/변경/삭제
• Fix: 버그 수정
• Docs: 문서 수정
• Style: 코드 형식(format), 세미콜론 누락 등 (코드 변경이 없는 경우)
• Refactor: 프로덕션 코드 리팩토링
• Test: 테스트 코드 추가, 테스트 리팩토링 (프로덕션 코드 변경이 없는 경우)
• Chore: 빌드 작업 수정, 패키지 매니저 설정 등 (프로덕션 코드 변경이 없는 경우)
• Etc: 기타

The Subject

• 타입은 영어로 작성하며, 대문자로 시작한다.
• 제목은 50자를 넘기지 않으며, 한글로 작성한다.
• 끝에 마침표를 붙이지 않으며, 과거형을 사용하지 않는다.

The Body

• 선택 사항
• 부연 설명이 필요하거나, Commit의 이유를 작성한다.
• 제목과 구분하기 위해 한 칸 띄워 작성한다.
• 한 줄에 72자를 넘기지 않는다.

The Footer

• 선택 사항
• Issue tracking이 필요할 때 작성한다.

Example Commit Message

Feat: 50자 이내로 변경 사항 요약

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123, #124
See also: #456, #789

Reference

• Udacity Git Commit Message Style Guide