Skip to content

๐ŸŒˆ ์ข‹์€ Git Commit message ์ž‘์„ฑ๋ฒ•

k-minsik edited this page Oct 24, 2023 · 2 revisions

๐ŸŒˆ ์ข‹์€ Git Commit message ์ž‘์„ฑ๋ฒ•

๐ŸŒŸ Commit message๋ฅผ ๊ทœ์น™์— ๋งž๊ฒŒ ์ž‘์„ฑ ํ•ด์•ผ ํ•  ์ด์œ 

  • ๋” ์ข‹์€ commit log ๊ฐ€๋…์„ฑ

  • ๋” ๋‚˜์€ ํ˜‘์—…๊ณผ ๋ฆฌ๋ทฐ ํ”„๋กœ์„ธ์Šค

  • ๋” ์‰ฌ์šด ์ฝ”๋“œ ์œ ์ง€๋ณด์ˆ˜

๐ŸŒŸ Commit message ๊ตฌ์กฐ

Commit message๋Š” ์ œ๋ชฉ, ๋ณธ๋ฌธ, ๊ผฌ๋ฆฌ๋ง๋กœ ๊ตฌ์„ฑ ์ œ๋ชฉ์€ ํ•„์ˆ˜ ์‚ฌํ•ญ์ด๋ฉฐ, ๋ณธ๋ฌธ๊ณผ ๊ผฌ๋ฆฌ๋ง์€ ์„ ํƒ์‚ฌํ•ญ

<type ํƒ€์ž…>: <subject ์ œ๋ชฉ>

<body ๋ณธ๋ฌธ, ์ƒ๋žต๊ฐ€๋Šฅ>

<footer ๊ผฌ๋ฆฌ๋ง, ์ƒ๋žต๊ฐ€๋Šฅ>

ex) docs: Add ProcessThread.md
ex) fix(ํ•จ์ˆ˜์ด๋ฆ„): ...

๐ŸŒŸ Type์˜ ์ข…๋ฅ˜

  • "type"์€ ํ”„๋กœ์ ํŠธ๋‚˜ ํŒ€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ๊ทœ์น™์ด๋‚˜ ๊ด€๋ก€์— ๋”ฐ๋ผ ๋‹ฌ๋ผ์ง‘๋‹ˆ๋‹ค. ๋งŽ์€ ์˜คํ”ˆ ์†Œ์Šค ํ”„๋กœ์ ํŠธ๋‚˜ ํŒ€๋“ค์ด ํŠน์ • ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ๊ทœ์น™์„ ๊ฐ€์ง€๊ณ  ์žˆ์œผ๋ฉฐ, ์ด๋Ÿฌํ•œ ๊ทœ์น™์„ ๋”ฐ๋ฅด๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.
  • ํ•˜์ง€๋งŒ ๊ฐœ์ธ ํ”„๋กœ์ ํŠธ๋‚˜ ์ •ํ•ด์ง„ ๊ทœ์น™์ด ์—†๋Š” ํ”„๋กœ์ ํŠธ์—์„œ๋Š” ์›ํ•˜๋Š” ๋Œ€๋กœ "type"์„ ์ •์˜ํ•˜๊ณ  ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
ํ‚ค์›Œ๋“œ ์‚ฌ์šฉ์‹œ์ 
feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
fix ๋ฒ„๊ทธ ์ˆ˜์ •
docs ๋ฌธ์„œ ์ˆ˜์ •
style ์ฝ”๋“œ์˜ ์˜๋ฏธ์— ์˜ํ–ฅ์„ ์ฃผ์ง€ ์•Š๋Š” ๋ณ€๊ฒฝ์‚ฌํ•ญ
(์ฝ”๋“œ ํฌ๋งคํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋“ฑ)
design ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ (CSS ๋“ฑ)
refactor ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•˜์ง€ ์•Š๋Š” ์ฝ”๋“œ ๋ณ€๊ฒฝ
perf ์„ฑ๋Šฅ์„ ํ–ฅ์ƒ์‹œํ‚ค๋Š” ์ฝ”๋“œ ๋ณ€๊ฒฝ
test ๋ˆ„๋ฝ๋œ ํ…Œ์ŠคํŠธ ์ถ”๊ฐ€ ๋˜๋Š” ๊ธฐ์กด ํ…Œ์ŠคํŠธ ์ˆ˜์ •
chore ๋นŒ๋“œ ํ”„๋กœ์„ธ์Šค ๋˜๋Š” ๋ณด์กฐ๋„๊ตฌ ๋ฐ ๋ผ์ดํ”„๋Ÿฌ๋ฆฌ ๋“ฑ์˜ ๋ณ€๊ฒฝ
ci CI ๊ด€๋ จ ์„ค์ • ์ˆ˜์ •
release ๋ฒ„์ ผ ๋ฆด๋ฆฌ์ฆˆ
rename ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •
remove ํŒŒ์ผ์„ ์‚ญ์ œ

๐ŸŒŸ Commit message 7๊ฐ€์ง€ ๊ทœ์น™

  1. ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์–ด ๊ตฌ๋ถ„ํ•ด์ค€๋‹ค
  2. ์ œ๋ชฉ์€ 50์ž ์ด๋‚ด๋กœ ์ž‘์„ฑํ•œ๋‹ค
  3. ์ œ๋ชฉ ์ฒซ ๊ธ€์ž๋Š” ๋Œ€๋ฌธ์ž๋กœ ์ž‘์„ฑํ•œ๋‹ค (type์ด ์•„๋‹™๋‹ˆ๋‹ค)
    • readme file modification โŒ
    • Readme file modification โญ•๏ธ
  4. ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š”๋‹ค
    • Open the door. โŒ
    • Open the door โญ•๏ธ
  5. ์ œ๋ชฉ์€ ๋ช…๋ น๋ฌธ์œผ๋กœ, ๊ณผ๊ฑฐํ˜•์„ ์‚ฌ์šฉํ•˜์ง€ ์•Š๊ณ  ๊ฐ„๊ฒฐํ•˜๊ฒŒ ์ž‘์„ฑํ•œ๋‹ค
    • I fixed the bug โŒ
    • Fix the bug โญ•๏ธ
  6. ๋ณธ๋ฌธ์˜ ๊ฐ ํ–‰์€ 72์ž ์ด๋‚ด๋กœ ์ž‘์„ฑํ•œ๋‹ค (์ค„ ๋ฐ”๊ฟˆ ์‚ฌ์šฉ)
  7. ๋ณธ๋ฌธ์€ ์–ด๋–ป๊ฒŒ ๋ณด๋‹ค ๋ฌด์—‡์„, ์™œ์— ๋Œ€ํ•˜์—ฌ ์„ค๋ช…ํ•œ๋‹ค

mvc_model1