Commit Message Convention - DDD-Community/pregen-server GitHub Wiki
Follows Udacity Git Commit Message Style Guide
Convention
Message Structure
type: Subject (#Issue)
body
footer
Type
feat
: 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
Subject
- 50์ ์ด๋ด
- ๋๋ฌธ์๋ก ์์
- ๋ง์นจํ๋ก ๋๋์ง ์์์ผ ํจ
- ๋ช
๋ น์กฐ๋ฅผ ์ฌ์ฉํ์ฌ commit์ด ์ง๊ธ ํ ์ผ์ ๋ํด ์ค๋ช
- For example, use change; not changed or changes.
Issue
- Subject ๋ค์ (#8) ํํ๋ก ์ด์ ๋ฒํธ ๋ถ์ฐฉ
- github ๋ด์์ ์ด์๋ฅผ ์ฝ๊ฒ ์ด์ด๋ณผ ์ ์๋๋ก ์ปค์คํฐ๋ง์ด์ง
(Optional) Body
- ์ปค๋ฐ์ ์์ธํ ์ค๋ช
๊ณผ ๋งฅ๋ฝ์ด ํ์ํ ๋ ์ฌ์ฉ
- ์ ๋ชฉ๊ณผ ๋ณธ๋ฌธ ์ฌ์ด์ ๊ณต๋ฐฑ ํ์
- ํ ์ค์ 72์ ์ด๋ด๋ก ์์ฑ
(Optional) Footer
- ์ด์ ํธ๋ํน์ ์ฌ์ฉ
Example
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