Git Commit Message Convention - leegwichan/StackOverFlow_Refactoring GitHub Wiki

โ—Ž ์ž‘์„ฑ ๊ทœ์น™

  • Git Message๋Š” ํ˜„์žฌ ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ ์„ค๋ช…ํ•ด์ฃผ๋Š” ํ•˜๋‚˜์˜ ๊ธ€์ด๋ฏ€๋กœ ํ•ด๋‹น ์ปค๋ฐ‹์—์„œ ์ž‘์—…ํ•œ ๋‚ด์šฉ์— ๋Œ€ํ•œ ์ดํ•ด๊ฐ€ ๊ฐ€๋Šฅํ•˜๋„๋ก ์ž‘์„ฑํ•จ
  • Commit์€ ์ž‘์—…์˜ ์ตœ์†Œ ๋‹จ์œ„๋กœ ์ง„ํ–‰ํ•˜๊ณ , ์ž‘์—…ํ•œ ๋ชจ๋“  ๋‚ด์šฉ์„ ์•„๋ž˜ ํ˜•์‹์— ๋งž์ถฐ ์ž‘์„ฑํ•  ๊ฒƒ

โ—Ž Convention

  • ์ „๋ฐ˜์ ์œผ๋กœ AngularJS Git Commit Message Conventions์˜ ๊ทœ์น™์„ ๋”ฐ๋ฅธ๋‹ค.
    • Jira์—์„œ Smart commit์„ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด commit message ๋งจ ์ฒ˜์Œ issue key๋ฅผ ์ถ”๊ฐ€ํ•จ
<issue key> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

โ—Ž Convention Details

  • issue key : Jira์—์„œ ์‚ฌ์šฉํ•˜๋Š” Issue์˜ key๋ฅผ ๋„ฃ์Œ
    • Jira์—์„œ ์ž๋™์œผ๋กœ commit๊ณผ issue๊ฐ€ ์—ฐ๊ฒฐ๋˜์–ด ๋ณด๊ธฐ ์šฉ์ดํ•˜๊ฒŒ ํ•จ
  • type : ํ•ด๋‹น ์ปค๋ฐ‹์˜ ํƒ€์ž…์„ ์ ์Œ
    • feat (๊ธฐ๋Šฅ ๊ตฌํ˜„), fix (๋ฒ„๊ทธ ์ˆ˜์ •), docs (๋ฌธ์„œํ™”), style (ํ˜•์‹ ๋งž์ถ”๊ธฐ, ์„ธ๋ฏธ์ฝœ๋ก  ๋„ฃ๊ธฐ, โ€ฆ), refactor (๋ฆฌํŒฉํ† ๋ง), test (๋ฏธ์ฒ˜ ์ถ”๊ฐ€ํ•˜์ง€ ๋ชปํ•œ ํ…Œ์ŠคํŠธ ๋ฐ ํ…Œ์ŠคํŠธ ์ผ€์ด์Šค ์ถ”๊ฐ€), chore (์œ ์ง€ ๋ณด์ˆ˜)
  • scope : ๋ฒ”์œ„๋ฅผ ์ง€์ •ํ•˜๋Š” ๋ชจ๋“  ๊ฒƒ์ด ๋  ์ˆ˜ ์žˆ๋‹ค[
    • ํŒŒ์ผ๋ช…, ๋„๋ฉ”์ธ๋ช…, location, browser, complie ...]()
  • subject : ํ˜„์žฌ ์ž‘์—…์„ ๊ฐ„๋žตํžˆ ํ•œ์ค„๋กœ ์š”์•ฝ
  • body : ๋ณ€๊ฒฝ์— ๋Œ€ํ•œ ๋™๊ธฐ์— ๋Œ€ํ•ด ์ž‘์„ฑ, ์ด์ „๊ณผ ๋‹ฌ๋ผ์ง„ ์  ์ž‘์„ฑ
  • footer : ์ฃผ์š” ๋ณ€๊ฒฝ ์‚ฌํ•ญ, ...
โš ๏ธ **GitHub.com Fallback** โš ๏ธ