Commit message template - mash-up-kr/Nawa-Invitation-Web GitHub Wiki

์ปค๋ฐ‹๋ฉ”์‹œ์ง€ ํ…œํ”Œ๋ฆฟ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.

<ํƒ€์ž…>(!): #<์ด์Šˆ ๋ฒˆํ˜ธ>. <์ œ๋ชฉ>

# ---
# ์ œ๋ชฉ์€ ํ•œ๊ธ€๋กœ
# ์ œ๋ชฉ์€ ๋ช…๋ น๋ฌธ์œผ๋กœ
# ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€
# ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌํ•˜๊ธฐ
# ๋ณธ๋ฌธ์€ "์–ด๋–ป๊ฒŒ" ๋ณด๋‹ค "๋ฌด์—‡์„", "์™œ"๋ฅผ ์„ค๋ช…ํ•˜๊ธฐ.
# ๋ณธ๋ฌธ์— ์—ฌ๋Ÿฌ์ค„์˜ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•  ๋• "-"๋กœ ๊ตฌ๋ถ„
# ์ œ๋ชฉ์€ ์ตœ๋Œ€ 30๊ธ€์ž ๊นŒ์ง€ ์ž‘์„ฑ
# ๋ณธ๋ฌธ์€ ํ•œ ์ค„์— ์ตœ๋Œ€ 72๊ธ€์ž ๊นŒ์ง€ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
# ---

# ----
# <ํƒ€์ž…> ๋ฆฌ์ŠคํŠธ
# feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ
# fix : ๋ฒ„๊ทธ ์ˆ˜์ •
# refactor : ์ฝ”๋“œ ๋ฆฌํŒฉํ„ฐ๋ง (์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ๋„ ํฌํ•จ, ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ )
# docs : ๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ
# test : ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ (๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ )
# chore : ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ (์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ • ๋“ฑ)
# BREAKING CHANGE๊ฐ€ ํ•„์š”ํ•  ๋• ํƒ€์ž… ์˜†์— ๋Š๋‚Œํ‘œ๋ฅผ ๋„ฃ์–ด์ฃผ์„ธ์š”.
# ---

์ฃผ์˜์‚ฌํ•ญ

  • Commit message template๋Š” Conventional Commit ๊ทœ์•ฝ์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.
  • scope๋Š” ์ž‘์„ฑํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

commit message template ์„ค์ •

https://junwoo45.github.io/2020-02-06-commit_template/

  • gitmessage.txt ์ƒ์„ฑ
vim ~/.gitmessage.txt
ํ…œํ”Œ๋ฆฟ ๋ถ™์—ฌ๋„ฃ๊ธฐ
:wq
  • git config ์„ค์ •
 # ํ˜„์žฌ ์ €์žฅ์†Œ์—๋งŒ ์„ค์ •
 git config commit.template ~/.gitmessage.txt

 # ์ „์—ญ์œผ๋กœ ์„ค์ •
 git config --global commit.template ~/.gitmessage.txt

git commit ๋ช…๋ น์–ด๋กœ ์ง€์ •๋œ ์ปค๋ฐ‹ ํ…œํ”Œ๋ฆฟ์„ ๋ถˆ๋Ÿฌ์˜ฌ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. :wq ์ €์žฅ์œผ๋กœ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋ฅผ ๋‚จ๊ธธ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

husky ์ด์šฉํ•ด์„œ commitlint, eslint ์„ค์ •

"husky": {
    "hooks": {
      "pre-commit": "npm run checkTs && lint-staged",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
โš ๏ธ **GitHub.com Fallback** โš ๏ธ