๋ณธ๋ฌธ ๋ฐ”๋กœ๊ฐ€๊ธฐ
๐Ÿ“™ Git

Clean Commit Message ๋ฅผ ์ž‘์„ฑํ•ด์•ผ ํ•˜๋Š” ์ด์œ 

by GroovyArea 2022. 5. 3.
Git ์„ ์ด์šฉํ•ด ํ”„๋กœ์ ํŠธ๋ฅผ ์ง„ํ–‰ํ•  ๋•Œ๋Š” ํ•ญ์ƒ commit message๋ฅผ ์ ๊ธฐ ๋งˆ๋ จ์ด๋‹ค. ํŠนํžˆ ํ˜‘์—…์—์„œ๋Š” ๋ฉ”์‹œ์ง€์˜ ๊ทœ์น™๊ณผ ๊ตฌ์ฒดํ™”๊ฐ€ ๊ฐ€ํžˆ ๊ทธ ์—ญํ• ์ด ํ•„์ˆ˜์ ์ด๋ผ๊ณ  ์ƒ๊ฐํ•œ๋‹ค. ๋‚˜ ์กฐ์ฐจ๋„ ์ปค๋ฐ‹ ๊ทœ์น™์„ ๋ชจ๋ฅด๊ณ  ๋‚ด ์ž…๋ง›์— ๋งž๊ฒŒ ์ž‘์„ฑํ–ˆ๋˜ ๊ฒฝํ—˜์ด ๋งŽ๋‹ค. ์ด๋ฒˆ ํ”„๋กœ์ ํŠธ๋ฅผ ์ง„ํ–‰ํ•˜๋ฉฐ clean commit message ์ „๋žต์„ ๊ณต๋ถ€ํ•˜๋ฉฐ ์ ์šฉ์‹œํ‚ฌ ๊ณ„ํš์ด๋‹ค. 

 

Commit์ด๋ž€?

- ์˜๋ฏธ ์žˆ๋Š” ๋ณ€ํ™”์— ๋Œ€ํ•ด ๊ธฐ๋กํ•˜๋Š” ๊ฒƒ์ด ๋ฐ”๋กœ commit!

- ํŠน์ • ์‹œ์ ์— ๋ณ€ํ™”์— ๋Œ€ํ•œ ์‚ฌํ•ญ์„ ๋ฉ”์‹œ์ง€์™€ ํ•จ๊ป˜ ๊ธฐ๋กํ•˜๋Š” ํฌ์ธํŠธ

 

ํŠน์ • ์‹œ์ ์ด๋ž€?

- ์ž‘์€ ๋ณ€ํ™”, ํฐ ๋ณ€ํ™”์ธ์ง€ ๊ฒฝ๊ณ„๊ฐ€ ๋ชจํ˜ธํ•จ

- ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๊ฐ€ ๊ฐ„๋‹จํ•  ์ˆ˜๋ก ๊ธฐ๋Šฅ์„ ์„ธ์„ธํ•˜๊ฒŒ ๋‚˜๋ˆˆ ๊ฒƒ์ด๊ธฐ ๋•Œ๋ฌธ์— ๋ฆฌ๋ทฐ๋„ ์‰ฝ๊ณ  ๋‹ค๋ฅธ ์‚ฌ๋žŒ์ด ์‰ฝ๊ฒŒ ์ดํ•ด๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค๊ณ  ์ƒ๊ฐํ•˜๊ธฐ ๋•Œ๋ฌธ์— ์ž‘์€ ์ปค๋ฐ‹์ด ์ข‹๋‹ค๊ณ  ์ƒ๊ฐํ•œ๋‹ค.

 

Clean Commit Message

  • ํ›—๋‚  ๋‹ค์‹œ ๋ด๋„ ์‰ฝ๊ฒŒ ๋– ์˜ค๋ฅด๋Š” ๋ฉ”์‹œ์ง€
  • ๊ฐ„๊ฒฐํ•œ ๋ฉ”์‹œ์ง€
  • ๋””ํ…Œ์ผํ•œ ๋ฉ”์‹œ์ง€ ๋“ฑ๋“ฑ

 

Clean Commit Message๋ฅผ ์ž‘์„ฑํ•˜๊ธฐ ์œ„ํ•œ 7๊ฐœ์˜ ๊ทœ์น™

  1. ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์–ด ๋ถ„๋ฆฌํ•˜๊ธฐ
  2. ์ œ๋ชฉ์€ ์˜๋ฌธ ๊ธฐ์ค€ 50์ž ์ด๋‚ด๋กœ
  3. ์ œ๋ชฉ ์ฒซ๊ธ€์ž๋ฅผ ๋Œ€๋ฌธ์ž๋กœ
  4. ์ œ๋ชฉ ๋์— [ . ] ๊ธˆ์ง€
  5. ์ œ๋ชฉ์€ ๋ช…๋ น์กฐ๋กœ
  6. ๋ณธ๋ฌธ์€ ์˜๋ฌธ ๊ธฐ์ค€ 72์ž๋งˆ๋‹ค ์ค„ ๋ฐ”๊ฟˆ
  7. ๋ณธ๋ฌธ์€ ์–ด๋–ป๊ฒŒ ๋ณด๋‹ค ๋ฌด์—‡์„ , ์™œ ์— ๋งž์ถฐ ์ž‘์„ฑ

=> ๋‚˜ ๊ฐ™์€ ๊ฒฝ์šฐ๋Š” ๊ตณ์ด ์˜๋ฌธ์„ ์ด์šฉํ•˜๊ธฐ ๋ณด๋‹ค ๊ฐ„๊ฒฐํ•œ ํ•œ๊ธ€ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•  ๊ณ„ํš์ด๋‹ค. ํšŒ์‚ฌ์— ๋“ค์–ด๊ฐ€์„œ ์ผ์„ ํ•˜๊ฒŒ ๋˜๋ฉด ํšŒ์‚ฌ์— ๋งž๋Š” ์ปค๋ฐ‹ ๊ทœ์น™์„ ์ƒˆ๋กœ ๊ณต๋ถ€ํ•˜์ž๋Š” ์ƒ๊ฐ์„ ํ–ˆ๋‹ค.

๋ฐ˜์‘ํ˜•

'๐Ÿ“™ Git' ์นดํ…Œ๊ณ ๋ฆฌ์˜ ๋‹ค๋ฅธ ๊ธ€

PR์„ ์ž‘์„ฑํ•˜๋Š” ์ข‹์€ ๋ฐฉ๋ฒ•  (0) 2022.05.03
Git Flow ๋ž€ ๋ฌด์—‡์ผ๊นŒ?  (0) 2022.05.03