Skip to content

๐Ÿ™ ์ œ์ด์ฝฅ๊ณผ ๋ธŒ๋ผ์šฐ๋‹ˆ์˜ ๊นƒ ์ปจ๋ฒค์…˜ ๐Ÿ™

JinHo Jeong edited this page Jun 8, 2024 · 2 revisions

6. Github Conventions

  • ๊ธฐ๋ณธ์ ์œผ๋กœ Git Flow๋ฅผ ์ค€์ˆ˜ํ•œ๋‹ค.

gitflow_1

  • Release Branch ๋ณ‘ํ•ฉ ์™„๋ฃŒ ์‹œ ํ…Œ์ŠคํŠธ ์•ฑ ํ…Œ์Šคํ„ฐ ๋ฐฐํฌ
  • Main Branch ๋ณ‘ํ•ฉ ์™„๋ฃŒ ์‹œ ๋ฆด๋ฆฌ์ฆˆ ์•ฑ ๋งˆ์ผ“ ๋ฐฐํฌ

6-1. ๊ฐœ๋ฐœ ํ”„๋กœ์„ธ์Šค

1. Issue๋ฅผ ์ƒ์„ฑํ•œ๋‹ค.
2. feature Branch๋ฅผ ์ƒ์„ฑํ•œ๋‹ค.
3. Add - Commit - Push - Pull Request ์˜ ๊ณผ์ •์„ ๊ฑฐ์นœ๋‹ค.
4. Pull Request๊ฐ€ ์ž‘์„ฑ๋˜๋ฉด ์ž‘์„ฑ์ž ์ด์™ธ์˜ ๋‹ค๋ฅธ ํŒ€์›์ด Code Review๋ฅผ ํ•œ๋‹ค.
5. Code Review๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด Pull Request ์ž‘์„ฑ์ž๊ฐ€ develop Branch๋กœ merge ํ•œ๋‹ค.
6. merge๋œ ์ž‘์—…์ด ์žˆ์„ ๊ฒฝ์šฐ, ๋‹ค๋ฅธ ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—…์„ ์ง„ํ–‰ ์ค‘์ด๋˜ ๊ฐœ๋ฐœ์ž๋Š” ๋ณธ์ธ์˜ ๋ธŒ๋žœ์น˜๋กœ merge๋œ ์ž‘์—…์„ Pull ๋ฐ›์•„์˜จ๋‹ค.
7. ์ข…๋ฃŒ๋œ Issue์™€ Pull Request์˜ Label๊ณผ Project๋ฅผ ๊ด€๋ฆฌํ•œ๋‹ค.

6-2. Commit Convention

- [CHORE] : ๋™์ž‘์— ์˜ํ–ฅ ์—†๋Š” ์ฝ”๋“œ or ๋ณ€๊ฒฝ ์—†๋Š” ๋ณ€๊ฒฝ์‚ฌํ•ญ(์ฃผ์„ ์ถ”๊ฐ€ ๋“ฑ) or  ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์ถ”๊ฐ€, ์ƒˆ๋กœ์šด ํŒŒ์ผ ์ƒ์„ฑ
- [FEAT] : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„
- [FIX] : ๋ฒ„๊ทธ, ์˜ค๋ฅ˜ ํ•ด๊ฒฐ
- [DOCS] : README๋‚˜ WIKI ๋“ฑ์˜ ๋ฌธ์„œ ์ˆ˜์ •
- [REFACTOR] : ์ „๋ฉด ์ˆ˜์ •
- [MERGE]: ๋‹ค๋ฅธ ๋ธŒ๋žœ์น˜์™€ ๋ณ‘ํ•ฉ
  • ์ปค๋ฐ‹์‹œ, ์ด์Šˆ๋ฒˆํ˜ธ์™€ ์ปค๋ฐ‹ ์ข…๋ฅ˜๋ฅผ ํ•จ๊ป˜ ๋ช…์‹œํ•œ๋‹ค.
    • [FEAUTRE/FIX โ€ฆ ] #์ด์Šˆ๋ฒˆํ˜ธ : ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ํ˜•์‹
  • ex) "[FEATURE]#1 : ํšŒ์›๊ฐ€์ž… ๊ธฐ๋Šฅ ์™„๋ฃŒ"

6-3. Branch Convention

- [develop] : ์ตœ์ข… ๋ฐฐํฌ
- [feature] : ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- [fix] : ์—๋Ÿฌ ์ˆ˜์ •, ๋ฒ„๊ทธ ์ˆ˜์ •
- [docs] : README, ๋ฌธ์„œ
- [refactor] : ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง (๊ธฐ๋Šฅ ๋ณ€๊ฒฝ ์—†์ด ์ฝ”๋“œ๋งŒ ์ˆ˜์ •ํ•  ๋•Œ)
- [chore] : gradle ์„ธํŒ…, ์œ„์˜ ๊ฒƒ ์ด์™ธ์— ๊ฑฐ์˜ ๋ชจ๋“  ๊ฒƒ
  • ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ ์‹œ, ๋ธŒ๋žœ์น˜ ์ข…๋ฅ˜์™€ ๊ฐœ๋ฐœ์ž ์ด๋ฆ„, ์ปค๋ฐ‹ ์ข…๋ฅ˜๋ฅผ ํ•จ๊ป˜ ๋ช…์‹œํ•œ๋‹ค.
    • ํ˜•์‹ : ๋ธŒ๋žœ์น˜์ข…๋ฅ˜/๊ฐœ๋ฐœ์ž์ด๋ฆ„/#์ด์Šˆ๋ฒˆํ˜ธ
  • ex) : feature/jaino/#123