Skip to content

Git Convention

JB0129 edited this page Aug 29, 2023 · 8 revisions

Git Branch Convention

ํ”„๋กœ์ ํŠธ์˜ ํŒ€์›๋“ค์€ ์•„๋ž˜์™€ ๊ฐ™์€ Git ๋ธŒ๋žœ์น˜๋ช… ๊ทœ์น™์„ ๋”ฐ๋ผ ๋ธŒ๋žœ์น˜๋ฅผ ๊ด€๋ฆฌํ•ฉ๋‹ˆ๋‹ค.
์ด ๊ทœ์น™์€ ํŒ€์›๋“ค์ด ๋ธŒ๋žœ์น˜๋ฅผ ์ผ๊ด€์„ฑ ์žˆ๊ฒŒ ์ƒ์„ฑํ•˜๊ณ  ๊ด€๋ฆฌํ•˜์—ฌ ํ˜‘์—…์„ ์›ํ• ํ•˜๊ฒŒ ํ•˜๋„๋ก ๋„์™€์ค๋‹ˆ๋‹ค.

๊ธฐ๋ณธ ๋ธŒ๋žœ์น˜

  • ๋ฉ”์ธ ๋ธŒ๋žœ์น˜ : 'main'
  • ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜ : 'dev'

๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜

  • FE ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜ : 'feDev'
  • BE ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜ : 'beDev'

๊ธฐ๋Šฅ ๋ธŒ๋žœ์น˜

  • FE ๊ธฐ๋Šฅ ๋ธŒ๋žœ์น˜ : 'fe/[ํƒ€์ž…]/[๊ธฐ๋Šฅ ์ด๋ฆ„]/[#์ด์Šˆ๋ฒˆํ˜ธ]'
    (์˜ˆ์‹œ) : fe/feat/login/#1
  • BE ๊ธฐ๋Šฅ ๋ธŒ๋žœ์น˜ : 'be/[ํƒ€์ž…]/[๊ธฐ๋Šฅ ์ด๋ฆ„]/[#์ด์Šˆ๋ฒˆํ˜ธ]'
    (์˜ˆ์‹œ) : be/feat/login/#1

Git Issues Convention

์ œ๋ชฉ

[FE] `์ž์‹ ์ด ํ•˜๊ณ ์ž ํ•˜๋Š” ๊ธฐ๋Šฅ`
[BE] `์ž์‹ ์ด ํ•˜๊ณ ์ž ํ•˜๋Š” ๋ถ€๋ถ„`

๋‚ด์šฉ

๋งŒ๋“ค๊ณ ์ž ํ•˜๋Š” ๊ธฐ๋Šฅ์ด ๋ฌด์—‡์ธ๊ฐ€์š”?
- ex) Todo ์ƒ์„ฑ ๊ธฐ๋Šฅ

ํ•ด๋‹น ๊ธฐ๋Šฅ์„ ๊ตฌํ˜„ํ•˜๊ธฐ ์œ„ํ•ด ํ•  ์ผ์ด ๋ฌด์—‡์ธ๊ฐ€์š”?
- [ ] Job1
- [ ] Job2
- [ ] Job3

์˜ˆ์ƒ ์ž‘์—… ์‹œ๊ฐ„
- ex) 3h

Git PullRequest Convention

์ œ๋ชฉ

[FE] `์ž์‹ ์ด ์ˆ˜ํ–‰ํ•œ ๊ธฐ๋Šฅ`
[BE] `์ž์‹ ์ด ์ˆ˜ํ–‰ํ•œ ๋ถ€๋ถ„`
### ๊ตฌํ˜„ํ•œ ๊ธฐ๋Šฅ์ด ๋ฌด์—‡์ธ๊ฐ€์š”?
- ex) Todo ์ƒ์„ฑ ๊ธฐ๋Šฅ

### ํ•ด๋‹น ๊ธฐ๋Šฅ์˜ ์„ธ๋ถ€์‚ฌํ•ญ์—๋Š” ๋ฌด์—‡์ด ์žˆ๋‚˜์š”?
- Job1
- Job2
- Job3

### ์ถ”ํ›„ ํ•ด์•ผํ•  ์ผ
- job1