Commit Message Convention

참고 : Udacity Git Commit Message Style Guide

소개

Udacity에서 제안하는 규약을 일부 차용하면서 Commit 메시지는 최대한 자유로운 형식을 가져가는 방향입니다.

---

Issue Messages

TBD

Commit Messages

Message Structure

커밋 메세지는 세 문단(title,body,footer)으로 구성되며 각 문단은 blank line으로 구분합니다.

이때 title문단은 필수, body, footer문단은 생략이 가능합니다.

세부적으로 title 문단은 subject와issue No.로 구성되고, issue No.는 생략이 가능합니다.

레이아웃은 다음과 같습니다.

type: Subject (issue No.)

body

footer

The Type

TBD 타입의 경우 작은(minor)수정과 비교적 큰(major)수정에 대하여 몇가지 케이스를 두고 상황에 맞는 것을 적용합니다.

• Add

• Create

• Write

• Upload

• Update

• Remove

• 그 외 필요한 상황에 따라 적절한 imperative verb 를 사용한다.

• Feature: A new feature / 기능 추가

• Fix: A bug fix / 버그 픽스

• Docs: Changes to documentation / 문서 관련

• Style: Formatting, missing semi colons, etc; no code change / 코드 스타일 관련

• Refactor: Refactoring production code / 코드 리펙터링

• Test: Adding tests, refactoring test; no production code change / 테스트 관련

• Chore: Updating build tasks, package manager configs, etc; no production code change / 코드외 기타 작업

• Publish: Publishing new production version / 버젼 업데이트 관련

The Subject

Subject는 글자수 50을 넘지 않고 영문 대문자로 시작하며 마침표를 찍지 않습니다. imperative tone(명령조)로 무엇을 commit 했는지 작성합니다. (For example, use change; not changed or changes.)

The issue

연관된 이슈나 대표하는 이슈를 같이 엮어 줍니다.

The Body

보다 구체적인 설명이 필요할시 작성합니다. 설명은 어떻게 하였는지 보단 무엇을 왜 했는지 작성하도록 합니다.

The Footer

하나 이상의 이슈 트래커가 관계되거나 부차적인 설명이 필요한 이슈 트래커가 있을시 작성합니다.

Example Commit Message

feat: Summarize changes in around 50 characters or less

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
See also: #456, #789