Commit Convention - boostcampwm-2024/web08-BooQuiz GitHub Wiki

Git Commit Convetion

Commit Message Structure

<type>: <subject>

<body>

[footer - ์ด์Šˆ ์ฐธ์กฐ]
EPIC: #{๋ฒˆํ˜ธ}
Story: #{๋ฒˆํ˜ธ}
Task: #{๋ฒˆํ˜ธ}

Type ์ข…๋ฅ˜

Type ์„ค๋ช…
feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€
fix ๋ฒ„๊ทธ ์ˆ˜์ •
design CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
!breaking change ์ปค๋‹ค๋ž€ API ๋ณ€๊ฒฝ์˜ ๊ฒฝ์šฐ
!hotfix ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ๋ฒ„๊ทธ๋ฅผ ๊ณ ์ณ์•ผํ•˜๋Š” ๊ฒฝ์šฐ
style ์ฝ”๋“œ ํฌ๋งท ๋ณ€๊ฒฝ, ์„ธ๋ฏธ ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์ˆ˜์ •์ด ์—†๋Š” ๊ฒฝ์šฐ
refactor ํ”„๋กœ๋•์…˜ ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
comment ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
docs ๋ฌธ์„œ ์ˆ˜์ •
test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€, Production Code ๋ณ€๊ฒฝ ์—†์Œ
chore ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๊ด€๋ฆฌ์ž ๊ตฌ์„ฑ ๋“ฑ ์—…๋ฐ์ดํŠธ, Production Code ๋ณ€๊ฒฝ ์—†์Œ
rename ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ
remove ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ

Commit Message ์ž‘์„ฑ ๊ทœ์น™

  1. type์€ ๋ชจ๋‘ ์†Œ๋ฌธ์ž๋กœ ์ž‘์„ฑ
  2. ์ œ๋ชฉ์€ ๋ช…๋ น๋ฌธ์œผ๋กœ ์ž‘์„ฑ
  3. ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€
  4. ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌํ•˜๊ธฐ
  5. ๋ณธ๋ฌธ์€ "์–ด๋–ป๊ฒŒ" ๋ณด๋‹ค "๋ฌด์—‡์„", "์™œ"๋ฅผ ์„ค๋ช…
  6. ๋ณธ๋ฌธ์— ์—ฌ๋Ÿฌ์ค„์˜ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•  ๋• "-"๋กœ ๊ตฌ๋ถ„
  7. footer๋Š” ๋ฐ˜๋“œ์‹œ ์ž‘์—…๊ณผ ๊ด€๋ จ๋œ ์ด์Šˆ๋ฒˆํ˜ธ๋ฅผ ํฌํ•จ

Footer ์ž‘์„ฑ ๊ทœ์น™

  1. EPIC, Story, Task ์ˆœ์„œ๋กœ ์ž‘์„ฑ
  2. ๊ฐ ๋‹จ์œ„๋Š” ์ƒˆ๋กœ์šด ์ค„์— ์ž‘์„ฑ
  3. ์ด์Šˆ ๋ฒˆํ˜ธ๋Š” '#' ๊ธฐํ˜ธ์™€ ํ•จ๊ป˜ ์ž‘์„ฑ
  4. ๊ด€๋ จ ์—†๋Š” ๋‹จ์œ„๋Š” ์ƒ๋žต ๊ฐ€๋Šฅ

์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์˜ˆ์‹œ

์˜ˆ์‹œ 1: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€

feat: ํšŒ์›๊ฐ€์ž… ์ด๋ฉ”์ผ ์ธ์ฆ ๊ธฐ๋Šฅ ๊ตฌํ˜„

- ์ธ์ฆ ๋ฉ”์ผ ๋ฐœ์†ก ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- ์ธ์ฆ ์ฝ”๋“œ ํ™•์ธ ๋กœ์ง ๊ตฌํ˜„
- ์ธ์ฆ ์ƒํƒœ DB ์ €์žฅ ์ฒ˜๋ฆฌ

EPIC: #123
Story: #456
Task: #789

์˜ˆ์‹œ 2: ๋ฒ„๊ทธ ์ˆ˜์ •

fix: ๋น„๋ฐ€๋ฒˆํ˜ธ ์žฌ์„ค์ • ์ด๋ฉ”์ผ ๋ฐœ์†ก ์˜ค๋ฅ˜ ์ˆ˜์ •

- SMTP ์„ค์ • ์˜ค๋ฅ˜ ์ˆ˜์ •
- ์ด๋ฉ”์ผ ํ…œํ”Œ๋ฆฟ ๊นจ์ง ํ˜„์ƒ ํ•ด๊ฒฐ

Story: #222
Task: #333

์˜ˆ์‹œ 3: ๋ฆฌํŒฉํ† ๋ง

refactor: ์ธ์ฆ ์„œ๋น„์Šค ๋ชจ๋“ˆ ๋ฆฌํŒฉํ† ๋ง

- ์ค‘๋ณต ์ฝ”๋“œ ์ œ๊ฑฐ
- ์ธ์ฆ ๋กœ์ง ๋‹จ์ผ ์ฑ…์ž„ ์›์น™ ์ ์šฉ
- ํ…Œ์ŠคํŠธ ์ผ€์ด์Šค ๋ณด๊ฐ•

EPIC: #444
Task: #555

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

  1. Task ๋ฒˆํ˜ธ๋Š” ๋ฐ˜๋“œ์‹œ ํฌํ•จํ•˜์—ฌ ์ž‘์„ฑ
  2. EPIC์ด๋‚˜ Story๋Š” ๊ด€๋ จ๋œ ๊ฒฝ์šฐ์—๋งŒ ํฌํ•จ
  3. ํ•˜๋‚˜์˜ ์ปค๋ฐ‹์€ ๊ฐ€๋Šฅํ•œ ํ•˜๋‚˜์˜ Task์—๋งŒ ์—ฐ๊ด€๋˜๋„๋ก ์ž‘์„ฑ
  4. ์—ฌ๋Ÿฌ Task์— ๊ฑธ์นœ ์ž‘์—…์˜ ๊ฒฝ์šฐ, ๊ฐ€์žฅ ๊ด€๋ จ๋„๊ฐ€ ๋†’์€ Task๋ฅผ ๋งจ ์œ„์— ์ž‘์„ฑ
โš ๏ธ **GitHub.com Fallback** โš ๏ธ