git commit template - swkim0128/PARA GitHub Wiki


type: Git archive: false

git commit template

$ git config --global commit.template ~/git_commit_template.txt

or

# .gitconfig
[commit]
template=~/git_commit_template.txt

# ๋ ˆํฌ์ง€ํ† ๋ฆฌ๋ณ„
# repository/.git/config
[commit]
template=repository/git_commit_template.txt
  • ๋‚ด๊ฐ€ ์‚ฌ์šฉํ•˜๋Š” commit template
# Header <Type>:<Title>

# -- Type -- 
# ENG  : ๊ฐœ์„ ํ•˜๊ฑฐ๋‚˜ ์‹ ๊ธฐ๋Šฅ ์ถ”๊ฐ€ (Engancement)
# BUG  : ๋ฒ„๊ทธ
# DOC  : ๋ฌธ์„œํ™” ๊ด€๋ จ๋œ ์ž‘์—… (Document)
# TST  : ์ƒˆ๋กœ์šด ์œ ๋‹›ํ…Œ์ŠคํŠธ๋ฅผ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ ๊ธฐ์กด ํ…Œ์ŠคํŠธ๋ฅผ ์ˆ˜์ • (Test)
# BLD  : ๋นŒ๋“œ ํ”„๋กœ์„ธ์Šค ๊ด€๋ จ ์ฝ”๋“œ ํ˜น์€ ์Šคํฌ๋ฆฝํŠธ๋ฅผ ์ˆ˜์ • (Build)
# PERF : ๊ณ„์‚ฐ ์†๋„์˜ ๊ฐœ์„ ๊ณผ ๊ด€๋ จ๋œ ์ž‘์—… (Performance)
# CLN  : ์ฝ”๋“œ๋ฅผ ์ •๋ฆฌํ•˜๊ฑฐ๋‚˜ ๋ฆฌํŒฉํ† ๋งํ•œ ์ž‘์—… (Cleanup)
# ---

# Text

# Footer

# Commit Message rule
# 1. ์ œ๋ชฉ ์ค„์€ 50์ž ๋‚ด๋กœ ์ž‘์„ฑ.
# 2. ์ œ๋ชฉ ์ฒซ ๊ธ€์ž๋ฅผ ๋Œ€๋ฌธ์ž๋กœ
# 3. ์ œ๋ชฉ์€ ๋ช…๋ น๋ฌธ์œผ๋กœ
# 4. ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€
# 5. ๋ณธ๋ฌธ์€ ํ•œ ์ค„ ๋‹น 72์ž ๋‚ด๋กœ ์ž‘์„ฑํ•œ๋‹ค.
# 6. ๋ณธ๋ฌธ ๋‚ด์šฉ์€ ์–‘์— ๊ตฌ์• ๋ฐ›์ง€ ์•Š๊ณ  ์ตœ๋Œ€ํ•œ ์ƒ์„ธํžˆ ์ž‘์„ฑํ•œ๋‹ค.
# 7. ๋ณธ๋ฌธ์€ "์–ด๋–ป๊ฒŒ" ๋ณด๋‹ค "๋ฌด์—‡์„", "์™œ"๋ฅผ ์„ค๋ช…ํ•œ๋‹ค.
# 8. ๊ผฌ๋ฆฌ๋ง์—๋Š” ์ด์Šˆ ํŠธ๋ž˜์ปค๋ฅผ ์ž‘์„ฑํ•œ๋‹ค.
# 9. ๊ผฌ๋ฆฌ๋ง์€ "์œ ํ˜•:#์ด์Šˆ๋ฒˆํ˜ธ" ํ˜•์‹์œผ๋กœ ์ž‘์„ฑํ•œ๋‹ค.
โš ๏ธ **GitHub.com Fallback** โš ๏ธ