Skip to content

Git Convention

์ด์žฌ์› edited this page Sep 23, 2024 · 2 revisions

1. Git Commit Message Convention

1. Commit Tag ์ง€์ •

  • Tag๋Š” ์ฒซ ๋ฒˆ์งธ ๋ฌธ์ž๋งŒ ๋Œ€๋ฌธ์ž๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. (e.g. Feat)
Tag Name Description
Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€
Fix ๋ฒ„๊ทธ ์ˆ˜์ •
Style ์ฝ”๋“œ ํฌ๋งท ๋ณ€๊ฒฝ, ์„ธ๋ฏธ ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์ˆ˜์ •์ด ์—†๋Š” ๊ฒฝ์šฐ
Refactor ํ”„๋กœ๋•์…˜ ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
Comment ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
Docs ๋ฌธ์„œ ์ˆ˜์ •
Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€, Production Code(์‹ค์ œ๋กœ ์‚ฌ์šฉํ•˜๋Š” ์ฝ”๋“œ) ๋ณ€๊ฒฝ ์—†์Œ
Chore ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๊ด€๋ฆฌ์ž ๊ตฌ์„ฑ ๋“ฑ ์—…๋ฐ์ดํŠธ, Production Code ๋ณ€๊ฒฝ ์—†์Œ
Rename ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ
Remove ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ

2. ์ œ๋ชฉ์€ ํ•œ๊ธ€ ๊ธฐ์ค€ 50์ž ์ด๋‚ด๋กœ ์ž‘์„ฑํ•  ๊ฒƒ

2. Git branch strategy

Github Flow๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

  • main : ๋ฐฐํฌ๋œ ์‚ฐ์ถœ๋ฌผ ์ €์žฅ๋  ๋ธŒ๋žœ์น˜
  • feature : ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜, ์ด์Šˆ๋ณ„/์ž‘์—…๋ณ„๋กœ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ
    • feature/#{issue-number}/{feature-name}์˜ ์–‘์‹์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.

3. PR

  • PR ์˜ฌ๋ฆฌ๊ธฐ โ†’ CI ํ…Œ์ŠคํŠธ ํ†ต๊ณผ โ†’ ๋ฆฌ๋ทฐ ์š”์ฒญ โ†’ ์Šน์ธ ์™„๋ฃŒ โ†’ merge