Skip to content

02_Git Commit Convention

Seul Lee edited this page Dec 28, 2022 · 2 revisions

๐Ÿ“Œย Commit Message ์ž‘์„ฑ ๊ทœ์น™

์œ ํ˜•๋“ค์ด ๋ณตํ•ฉ์ ์œผ๋กœ ํฌํ•จ๋˜์–ด ์žˆ์„ ๊ฒฝ์šฐ, ๋˜๋„๋ก ์ปค๋ฐ‹์„ ๋ถ„๋ฆฌํ•œ๋‹ค.

๋ถ„๋ฆฌ๊ฐ€ ์–ด๋ ค์šด ๊ฒฝ์šฐ ์•„๋ž˜ ์ˆœ์„œ์ƒ ์ƒ์œ„ ํ•ญ๋ชฉ์˜ ์œ ํ˜•์œผ๋กœ ์ž‘์„ฑํ•œ๋‹ค. (eg. ๊ธฐ๋Šฅ๊ณผ ํ…Œ์ŠคํŠธ๊ฐ€ ๋ชจ๋‘ ํฌํ•จ๋œ ๊ฒฝ์šฐ ๊ธฐ๋Šฅ์œผ๋กœ ์ž‘์„ฑ)

  • โœจย feat: ๊ธฐ๋Šฅ ์ถ”๊ฐ€, ์‚ญ์ œ, ๋ณ€๊ฒฝ - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ
  • ๐Ÿ’„ย design: CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ (ํ•˜์ง€๋งŒ ๋™์ž‘์— ์˜ํ–ฅ์„ ์ฃผ๋Š” ๋ณ€๊ฒฝ์€ ์—†์Œ)
  • ๐Ÿ›ย fix: ๋ฒ„๊ทธ ์ˆ˜์ • - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ
  • ๐Ÿ“ย docs: ๋ฌธ์„œ ์ถ”๊ฐ€, ์‚ญ์ œ, ๋ณ€๊ฒฝ - ์ฝ”๋“œ ์ˆ˜์ • ์—†์Œ
  • ๐ŸŽจย style: ์ฝ”๋“œ ํ˜•์‹, ์ •๋ ฌ, ์ฃผ์„ ๋“ฑ์˜ ๋ณ€๊ฒฝ, eg. ์„ธ๋ฏธ์ฝœ๋ก  ์ถ”๊ฐ€ - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ, ํ•˜์ง€๋งŒ ๋™์ž‘์— ์˜ํ–ฅ์„ ์ฃผ๋Š” ๋ณ€๊ฒฝ์€ ์—†์Œ
  • โ™ป๏ธย refactor: ํŒŒ์ผ๊ตฌ์กฐ ๋ณ€๊ฒฝ, ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง, eg. renaming a variable - ์ œํ’ˆ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ
  • ๐Ÿงชย test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€, ์‚ญ์ œ, ๋ณ€๊ฒฝ ๋“ฑ - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ์—†์Œ. ํ…Œ์ŠคํŠธ ์ฝ”๋“œ์— ๊ด€๋ จ๋œ ๋ชจ๋“  ๋ณ€๊ฒฝ์— ํ•ด๋‹น
  • ๐Ÿ”งย config: ์˜์กด์„ฑ ๋ชจ๋“ˆ ๋“ฑ, ๊ธฐํƒ€ ์„ค์ • - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ์—†์Œ
  • ๐ŸŒฑย chore: ์„ค์ • ๋ณ€๊ฒฝ, ์žก๋‹คํ•œ ์—…๋ฌด
  • etc: ์œ„์— ํ•ด๋‹นํ•˜์ง€ ์•Š๋Š” ๋ชจ๋“  ๋ณ€๊ฒฝ, eg. ๋นŒ๋“œ ์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋ฐฐํฌ ์„ค์ • ๋ณ€๊ฒฝ - ์ฝ”๋“œ ์ˆ˜์ • ์—†์Œ

โœ๏ธย Commit Message ์˜ˆ์‹œ

์ฝ”๋“œ ํ…์ŠคํŠธ ํ‘œ์‹œ ๋‚ด์šฉ
์ปจ๋ฒค์…˜ โœจย feat: [#issuenumber] ๊ธฐ๋Šฅ ๊ตฌํ˜„ ๋‚ด์šฉ
์˜ˆ์‹œ โœจย feat: [#1] CommonInput ์ปดํฌ๋„ŒํŠธ ๊ตฌํ˜„

๐Ÿ—‚๏ธย commit message emoji

ํƒ€์ž… ์ด๋ชจ์ง€ ์ด๋ชจ์ง€ ์ฝ”๋“œ ์ฝ”๋“œ ์ˆ˜์ • ์—ฌ๋ถ€ ์ฝ”๋“œ ๋™์ž‘์— ์˜ํ–ฅ ์„ค๋ช…
Initial Commit ๐ŸŽ‰ :tada: X X ํ”„๋กœ์ ํŠธ ์ดˆ๊ธฐ ์„ค์ •
feat โœจ :sparkles: O O ๊ธฐ๋Šฅ ์ถ”๊ฐ€, ์‚ญ์ œ, ๋ณ€๊ฒฝ - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ
design ๐Ÿ’„ :lipstick: O O CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ
fix ๐Ÿ› :bug: O O ๋ฒ„๊ทธ ์ˆ˜์ •
docs ๐Ÿ“ :memo: X X ๋ฌธ์„œ ์ถ”๊ฐ€, ์‚ญ์ œ, ๋ณ€๊ฒฝ - ์ฝ”๋“œ ์ˆ˜์ • ์—†์Œ
style ๐ŸŽจ :art: O X ์ฝ”๋“œ ์ปจ๋ฒค์…˜ ์ˆ˜์ • - ๋™์ž‘์— ์˜ํ–ฅ์„ ์ฃผ๋Š” ๋ณ€๊ฒฝ ์—†์Œ
refactor โ™ป๏ธ :recycle: O O ํŒŒ์ผ๊ตฌ์กฐ ๋ณ€๊ฒฝ, ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ฆฌ - ์ œํ’ˆ์ฝ”๋“œ ์ˆ˜์ • ๋ฐœ์ƒ
test ๐Ÿงช :test_tube: X X ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ๊ด€๋ จ ์ˆ˜์ • - ์ œํ’ˆ ์ฝ”๋“œ ์ˆ˜์ • โŒ
config ๐Ÿ”ง :wrench: X X ์˜์กด์„ฑ ๋ชจ๋“ˆ ๋“ฑ, ๊ธฐํƒ€ ์„ค์ •
chore ๐ŸŒฑ :seedling: X X ์„ค์ • ๋ณ€๊ฒฝ, ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ์žก๋‹คํ•œ ์—…๋ฌด
!BREAKING CHANGE ๐Ÿ’ฅ :boom: O O ์ปค๋‹ค๋ž€ api ๋ณ€๊ฒฝ์˜ ๊ฒฝ์šฐ
!HOTFIX ๐Ÿš‘ :ambulance: O O ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ๋ฒ„๊ทธ๋ฅผ ๊ณ ์ณ์•ผํ•˜๋Š” ๊ฒฝ์šฐ

Clone this wiki locally