Skip to content

Git Convention

Hyeonsoo Park edited this page May 29, 2024 · 1 revision

โ›™ Git Convention

์ด์Šˆ

  • ํ…œํ”Œ๋ฆฟ ์‚ฌ์šฉ
## ๐Ÿ About
* 

## ๐Ÿ€ Branch Name
feat/#?-

## ๐ŸŒฑ To do
- [ ]
  1. ์ด์Šˆ๋ฅผ ๋“ฑ๋กํ•  ๋•Œ๋Š” ๋งจ ์•ž์— ์ด์Šˆ ์ข…๋ฅ˜ ์“ฐ๊ธฐ (์˜ˆ: [feat] ๋กœ๊ทธ์ธ ๊ตฌํ˜„)
  2. ํ•˜๋‚˜์˜ ์ด์Šˆ๊ฐ€ ํฌ๋ฉด ๋‚ด๋ถ€์— task list ๋งŒ๋“ค์–ด์„œ ์„ธ๋ถ„ํ™”ํ•˜๊ธฐ
  3. ์ด์Šˆ์— ๋งž๋Š” label ๋‹ฌ๊ธฐ
  4. ์ด์Šˆ๋ฅผ ๋“ฑ๋กํ•˜๋ฉด ๋ฒˆํ˜ธ๊ฐ€ ํ• ๋‹น๋จ

๋ธŒ๋žœ์น˜

  1. ๋ธŒ๋žœ์น˜๋ช… = ๋ถ„๋ฅ˜ /#์ด์Šˆ ๋ฒˆํ˜ธ
chore/#3
feat/#3
  1. ํ•˜๋‚˜์˜ ๋ธŒ๋žœ์น˜์—์„œ๋Š” ํ•˜๋‚˜์˜ ์ด์Šˆ๋งŒ ์ž‘์—…ํ•จ
  2. ์ด์Šˆ๊ฐ€ ์ปค์„œ task list๋กœ ์„ธ๋ถ„ํ™”ํ–ˆ์œผ๋ฉด ๊ทธ ๋ธŒ๋žœ์น˜๋ฅผ task ๋ธŒ๋žœ์น˜๋กœ ๋‚˜๋ˆˆ ํ›„ ์ž‘์—…ํ•˜๊ธฐ (์˜ˆ: task/#23-1, task/#23-2)
  3. task ๋ธŒ๋žœ์น˜์—๋Š” 1๊ฐœ์˜ ์ปค๋ฐ‹๋งŒ ํ•˜๋Š” ๊ฒŒ ์ตœ์ข… ๋ชฉํ‘œ

์ปค๋ฐ‹

  1. ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์•ž์— [#์ด์Šˆ๋ฒˆํ˜ธ] ๋„ฃ๊ธฐ
  2. task ๋ธŒ๋žœ์น˜์ธ ๊ฒฝ์šฐ [#์ด์Šˆ๋ฒˆํ˜ธ-task์ˆซ์ž] ์ด๋Ÿฐ ์‹์œผ๋กœ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์•ž์— ์ถ”๊ฐ€ ์˜ˆ) [#23-1], [#17-3]
  3. ์ด๋ ‡๊ฒŒ ํ•˜๋ฉด ๊ทธ ์ปค๋ฐ‹์— ๊ด€๋ จ๋œ ์ด์Šˆ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Œ

PR

  • ํ…œํ”Œ๋ฆฟ ์‚ฌ์šฉ
    • Assignee์— ๋ณธ์ธ ๋“ฑ๋ก
    • Reviewer๋กœ ํŒ€์› ๋“ฑ๋ก
## โœ… ์ž‘์—…ํ•œ ๋‚ด์šฉ
 - 

## โญ๏ธ PR Point
 <!-- ํ”ผ๋“œ๋ฐฑ ๋ฐ›๊ณ  ์‹ถ์€ ๋ถ€๋ถ„, ๊ณต์œ ํ•˜๊ณ  ์‹ถ์€ ๋ถ€๋ถ„, ์ž‘์—… ๊ณผ์ •, ์ด์œ  -->
 -

## ๐Ÿ“ธ ์Šคํฌ๋ฆฐ์ƒท


## ๐Ÿ’ก ๊ด€๋ จ ์ด์Šˆ
- Resolved: #
  1. PR(Pull Request) ์˜ฌ๋ฆฌ๊ธฐ
  2. ์ด์Šˆ๊ฐ€ ์ปค์„œ task ๋ธŒ๋žœ์น˜๋กœ ์ชผ๊ฐœ์„œ ์ž‘์—…์„ ํ•œ ๊ฒฝ์šฐ์—๋Š” ๊ธฐ์กด ์ด์Šˆ ๋ธŒ๋žœ์น˜ ๋ฐฉํ–ฅ์œผ๋กœ PR ์˜ฌ๋ฆฌ๊ธฐ
  3. task ๋ธŒ๋žœ์น˜๊ฐ€ ๊ธฐ์กด ์ด์Šˆ ๋ธŒ๋žœ์น˜๋กœ ๋ชจ๋‘ ๋‹ค ๋จธ์ง€ ๋˜๋ฉด ๊ธฐ์กด ์ด์Šˆ ๋ธŒ๋žœ์น˜๋Š” develop ๋ธŒ๋žœ์น˜ ๋ฐฉํ–ฅ์œผ๋กœ PR ์˜ฌ๋ฆฌ๊ธฐ
  4. Draft PR ์˜ฌ๋ ค์•ผ ๋œ๋‹ค๋ฉด PR๋ช… ์•ž์— [Draft PR-#๋ธŒ๋žœ์น˜๋ฒˆํ˜ธ] ๋ถ™์—ฌ์„œ ์˜ฌ๋ฆฌ๊ธฐ
  5. ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ›๊ณ  ํ”ผ๋“œ๋ฐฑ์„ ํ† ๋Œ€๋กœ ์ฝ”๋“œ๋ฅผ ์ˆ˜์ •ํ•œ ํ›„ ํ™•์ธ๋ฐ›๊ธฐ
  6. ๋งˆ์ง€๋ง‰์œผ๋กœ! โญ๏ธRebase and Mergeโญ๏ธ
Clone this wiki locally