Git Convention - 100-hours-a-week/5-yeosa-wiki GitHub Wiki

5-yeosa-ongi

๐Ÿงพ Commit Convention ๐Ÿค

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

Commit Convention Detail

  • <ํƒ€์ž…>: <์ œ๋ชฉ> ์˜ ํ˜•์‹์œผ๋กœ ์ œ๋ชฉ์„ ์•„๋ž˜ ๊ณต๋ฐฑ์ค„์— ์ž‘์„ฑ
  • ์ œ๋ชฉ์€ 50์ž ์ด๋‚ด / ๋ณ€๊ฒฝ์‚ฌํ•ญ์ด "๋ฌด์—‡"์ธ์ง€ ๋ช…ํ™•ํžˆ ์ž‘์„ฑ / ๋์— ๋งˆ์นจํ‘œ ๊ธˆ์ง€
  • ์˜ˆ) feat: ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ์ถ”๊ฐ€
  • ๋ณธ๋ฌธ(๊ตฌ์ฒด์ ์ธ ๋‚ด์šฉ)์„ ์•„๋žซ์ค„์— ์ž‘์„ฑ
  • ์—ฌ๋Ÿฌ ์ค„์˜ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•  ๋• "-"๋กœ ๊ตฌ๋ถ„ (ํ•œ ์ค„์€ 72์ž ์ด๋‚ด)
  • ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์€ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌ

Branch ์ „๋žต

  • main(prod)
  • dev
  • hotfix
  • feature (issue ์ƒ์„ฑ ํ›„ ๋ธŒ๋žœ์น˜ ๋งŒ๋“ค ๋•Œ) ex) feature/#5-๋กœ๊ทธ์ธ
  • fix
โš ๏ธ **GitHub.com Fallback** โš ๏ธ