gitcommitmessage ๋ฑ๋กํ๊ธฐ
๐ค๐ผ ๊ธฐ๋ฅ๋ณ๋ก ์ต๋ํ ์ชผ๊ฐ์ด ์ง๊ธฐ
Commit convention
- commit ์ปจ๋ฒค์
์ ์๋์ ๋ด์ฉ์ ๋ฐ๋ฅธ๋ค.
################
# type, body, footer๋ ๊ฐ๊ฐ ๊ณต๋ฐฑ ์ค๋ก ํ์นธ์ฉ ๋์์์ฑํฉ๋๋ค.
# 1. Type
# [Skill] type #์ด์๋ฒํธ: Subject (๊ณต๋ฐฑ ์์ฑ ์ ์ฃผ์)
# Ex)[FE] feat #22: ํ์์ ๋ณด ์์ ๊ธฐ๋ฅ ์ถ๊ฐ
# Ex)[BE] feat #22: ํ์์ ๋ณด ์์ ๊ธฐ๋ฅ ์ถ๊ฐ
################
# 1-1. Subject Type
# - design: UI์ ๋ณ๊ฒฝ์ฌํญ์ด ์๋ ๊ฒฝ์ฐ
# - deploy: ๋ฐฐํฌ์ ๊ด๋ จ๋ ์ปค๋ฐ
# - docs: readme.md, json ํ์ผ ๋ฑ ์์ , ๋ผ์ด๋ธ๋ฌ๋ฆฌ ์ค์น (๋ฌธ์ ๊ด๋ จ)
# - feat: ์๋ก์ด ๊ธฐ๋ฅ ๊ตฌํ
# - fix: ์ค๋ฅ ์์
# - refactor: ์ฝ๋ ๋ฆฌํฉํ ๋ง
# - setting: ๊ฐ๋ฐ ํ๊ฒฝ ๊ตฌ์ถ๊ณผ ๊ด๋ จ๋ ์ปค๋ฐ
# - style: ์ฝ๋์ ๋ณํ๊ฐ ์๋ ์์ (์ธ๋ฏธ์ฝ๋ก ๋ฑ)
# - test: ํ
์คํธ์ฝ๋ ๊ด๋ จ ์ปค๋ฐ
# 1-2. Subject
# - 50๊ธ์๋ฅผ ๋์ง ์๋๋ก ์์ฑ
# - ๋ง์นจํ ๋ฐ ํน์๊ธฐํธ๋ ์ฌ์ฉํ์ง ์์ต๋๋ค.
# - ์ ๋ชฉ์ ์์ ํ ์์ ํ ๋ฌธ์ฅ์ด ์๋๋ผ, ๊ฐ๊ฒฐํ๊ณ ์์ ์ ์ธ ์์ ์ ์ํด ๊ฐ์กฐ์ ๊ตฌ๋ฌธ์ ์ฌ์ฉ
################(์๋๋ ๊ณต๋ฐฑ ์ ์ง : Type๊ณผ Body์ ๊ตฌ๋ถ)
# 2. Body
# body๋ ์์
๋ด์ฉ์ด ๋ณต์กํ๊ฑฐ๋ ์์ธํ ๋ด์ฉ์ ๋จ๊ฒจ์ผ ํ๋ ๊ฒฝ์ฐ์๋ง ์์ฑ
# Ex)
# - ์ด๋ฏธ์ง ์
๋ก๋ ๊ธฐ๋ฅ ์ถ๊ฐ
# - ํ์ ์ ๋ณด ์์ api ์ฐ๋
################
# 2-1. Body ์์ฑ ๊ท์น
# - ๋ณธ๋ฌธ์ 72์ ๋ด๋ก ์์ฑ
# - ํ์ํ ๊ฒฝ์ฐ ์ฌ๋ฌ์ค๋ก๋ ์์ฑ ๊ฐ๋ฅ
# - ์ฌ๋ฌ ์ค์ ๋ฉ์์ง๋ฅผ ์์ฑํ ๋ "-"๋ก ๊ตฌ๋ถ
# - ๋ณ๊ฒฝ ๋ด์ฉ๋ณด๋ค ๋ณ๊ฒฝ ์ด์ ๋ฅผ ์์ฑํด์ผ ํ๋ค.(๋์ค์ ๋ดค์ ๋ ์ฝ๋ ์์ฑ ์ด์ ๋ฅผ ํ์
ํ๊ธฐ ์ํด)
################(์๋๋ ๊ณต๋ฐฑ ์ ์ง : Body์ Footer์ ๊ตฌ๋ถ)
# 3. Footer
# ์ ํ ์ฌํญ์ผ๋ก ์ฝ๋ ์์
๊ณผ ๊ด๋ จ๋ ์ด์ ๋ฒํธ ๋๋ ์ฐธ์กฐ ๋งํฌ ๋ฑ์ ์ถ๊ฐ
# Ex) Fixes: #1 (์ต์
_์ฌ๊ธฐ์ ์ด์๋ฒํธ์ []๋ฅผ ์น๋ฉด ์๋จ, ๋ฐ์ํ ๋ ค๋ฉด merge ํ์)
################
# 3-1. Footer(๊ผฌ๋ฆฌ๋ง) ์์ฑ ๊ท์น
# - ๊ผฌ๋ฆฌ๋ง์ optional์ด๋ฉฐ ์ด์ ํธ๋์ปค ID๋ฅผ ์์ฑ
# - ๊ผฌ๋ฆฌ๋ง์ "์ ํ: #์ด์ ๋ฒํธ" ํ์์ผ๋ก ์ฌ์ฉ
# - ์ฌ๋ฌ ๊ฐ์ ์ด์ ๋ฒํธ๋ฅผ ์ ์ ๋๋ ์ผํ(,)๋ก ๊ตฌ๋ถ
# 3-2. ์ด์ ํธ๋์ปค ์ ํ
# - Fixes: ์ด์ ์์ ์ค(์์ง ํด๊ฒฐ๋์ง ์์ ๊ฒฝ์ฐ)
# ์ต์ข
๋ฉ์ธ์ง ์์
# [FE] Feat #1: ํ์์ ๋ณด ์์ ๊ธฐ๋ฅ ์ถ๊ฐ
# (๊ณต๋ฐฑ ํ์)
# - ์ด๋ฏธ์ง ์
๋ก๋ ๊ธฐ๋ฅ ์ถ๊ฐ(์ต์
)
# - ํ์ ์ ๋ณด ์์ api ์ฐ๋(์ต์
)
# (๊ณต๋ฐฑ ํ์)
# Fixes: #1(์ต์
_์ฌ๊ธฐ์ ์ด์๋ฒํธ์ []๋ฅผ ์น๋ฉด ์๋จ, ๋ฐ์ํ ๋ ค๋ฉด merge ํ์)
#################
# ์ฐธ๊ณ ์ฌํญ
# - VS์ฝ๋ ์์์ ์ปค๋ฐ์ ๊ธ์๊ฐ ๋ฐ๋ฆฌ๋ ํ์์ด ๋ฐ์ํ๋๋ฐ ๊ฒฐ๊ณผ๋ฌผ์๋ ์ํฅ์ ์๋ฏธ์นฉ๋๋ค.
# - ^M์ ์ธ์ฝ๋ฉ๋ฌธ์ ๋ก ๋ฐ์ํ๋ ๊ฒ์ด๋ฏ๋ก ์ ๊ฒฝ์์ฐ์
๋๋ฉ๋๋ค.
#
# ์ปค๋ฐ ๋ฉ์์ง ํ
ํ๋ฆฟ ์ ์ฉ๋ฐฉ๋ฒ
# 1. local์์ ๋ช
๋ น์ด ์
๋ ฅํ๊ธฐ
# `git config --local commit.template .gitmessage.txt`
#
# 2. commit ํ๊ธฐ (vim ๊ธฐ์ค)
# - 'git add .'๋ฅผ ํตํด์ ๋ณ๊ฒฝ์ฌํญ์ด ์๋ ํ์ผ์ ์คํ
์ด์ง์ ์ฌ๋ฆฐ๋ค.
# - 'git commit' ์ ๋๋ฅด๊ณ ์ํฐ๋ฅผ ์น๋ฉด ์์ ํ
ํ๋ฆฟ์ด ๋์จ๋ค.
# - ํค๋ณด๋์์ 's'๋ฅผ ๋๋ฅด๊ณ ์์ ํ ์ดํ์ ๋ชจ๋ ์ปค๋ฐ๋ฉ์ธ์ง๋ฅผ ์
๋ ฅํ ํ, 'esc'๋ฅผ ๋๋ฅด๊ณ ๋น ์ ธ๋์จ๋ค.
# - ':wq'๋ฅผ ๋๋ฅด๊ณ ์ํฐ๋ฅผ ์น๋ฉด ์ ์์ ์ผ๋ก ์ปค๋ฐ์ด๋๋ค.