Team Rule 01: Git&GitHub Workflow - SWPP-2025SPRING/team-project-for-2025-spring-swpp-team-10 GitHub Wiki
๐ฟ Branching Strategy
๋น ๋ฅด๊ฒ ๊ฐ๋ฐํ๊ณ , ์์ฃผ ํตํฉํ๋ ๊ฒ ๋ชฉ์ ์ด๋ฏ๋ก Trunk-Based Development๋ฅผ ์ฌ์ฉํ๋ค.
๐ฑ Branching Strategy: ๋ธ๋์น ์ข ๋ฅ
๋ธ๋์น | ์ฉ๋ |
---|---|
main |
์์ ๋ ์ฝ๋, ๋ฐฐํฌ ๋ฐ ๋ฐ๋ชจ ์ฉ๋ |
feature/* |
๊ธฐ๋ฅ ๊ฐ๋ฐ์ฉ ๋ธ๋์น (๋จ๋ช , ๋น ๋ฅด๊ฒ ๋จธ์ง) |
asset/* |
์์ ์ถ๊ฐ์ฉ ๋ธ๋์น (PR ์ฆ์ ๋จธ์ง) |
Branching Strategy: ๋ธ๋์น ๋ค์ด๋ฐ
feature/๊ธฐ๋ฅ์ด๋ฆ
ํ์์ผ๋ก ์์ฑ- ๋ช ํํ๊ฒ ์ด๋ค ๊ธฐ๋ฅ์ธ์ง ๋๋ฌ๋๊ฒ ์์ฑ
# example
git checkout -b feature/wire-swing
git checkout -b feature/ui-checkpoint
git checkout -b feature/player-boost
์พ์ ํ ์์ ์ ์ํ ์ฃผ์์ฌํญ
- ๋ณ๋์ develop ๋ธ๋์น๋ฅผ ๋์ง ์๊ณ main๋ง์ ๊ด๋ฆฌํ๋ฏ๋ก ์๋ํ์ง ์๋ ์ฝ๋๋ฅผ main์ ๋ณํฉํ์ง ์๋๋ก ์ฃผ์ํ ๊ฒ!(๋น์ฐํ main์ ์ง์ ์ ์ธ push๋ X)
- feature ๋ธ๋์น์ main ๋ธ๋์น์ diff๊ฐ ๋๋ฌด ์ปค์ง์ง ์๋๋ก ์์ฃผ ๋ณํฉํ ๊ฒ!
๐ Commit Rule
- ํ์:
[ํ๊ทธ] ๊ธฐ๋ฅ ์์ฝ
- ๊ธฐ๋ณธ์ ์ผ๋ก ๋ช ํํ๊ณ ์ผ๊ด๋ ๋ฉ์์ง๋ฅผ ์์ฑ
Commit Rule: Commit Tag
[feat]
: ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ[fix]
: ๋ฒ๊ทธ ์์ [refactor]
: ์ฝ๋ ๋ฆฌํฉํ ๋ง[ui]
: UI ๋ณ๊ฒฝ[docs]
: ๋ฌธ์ ์์ [asset]
: ์์ ์ถ๊ฐ
์์:
git commit -m "[feat] ์์ด์ด ์ค์ ๊ธฐ๋ฅ ๊ตฌํ"
git commit -m "[fix] ํ์คํฐ ๋ฉ์ฌ ๋ฒ๋ฒ
์ด๋ ๋ฌธ์ ์์ "
git commit -m "[docs] README spring 1 TODO ์
๋ฐ์ดํธ"
๐ Pull Request Rule
- PR์ ํ ํ๋ฆฟ์ ๋ง์ถ์ด ์์ฑํ๋ค.
- Asset ์ถ๊ฐ๋ฅผ ์ ์ธํ ์์ค ์ฝ๋ ๋ณ๊ฒฝ์ Assignee์ ์น์ธ์ด ์๋ฃ๋์ด์ผ merge ๊ฐ๋ฅ
- Asset๋ง ๋ณ๊ฒฝํ PR์
asset
๋ผ๋ฒจ์ ๋จ๋ค
- Asset๋ง ๋ณ๊ฒฝํ PR์
- assignee๋ ๋ฆฌ๋ทฐ๋ PR์ด ์ด๋ฆฐ ์ดํ 3์ผ์ด ์ง๋๊ธฐ ์ ์ ๋ฆฌ๋ทฐํ๋ค.
- assignee์ approve๊ฐ ์ด๋ฃจ์ด์ง PR์ ์คํ๋ฆฐํธ ๋ง์คํฐ๊ฐ ๋จธ์งํ๋ค.
- ๋จธ์ง๋ squash ์์ด ์งํํ๋ค.
Assignee ์ง์ ๋ฐฉ์
PlayerAction
,Track
ํ์ ํ ๋ด ์์ ์ ์ด์ธ 1๋ช ์ด assignee๊ฐ ๋๋ค.UI
ํ์ 1๋ช ์ด๋ฏ๋ก ์ ์ ํ TEAM 10์ ๋ฉค๋ฒ ์ค 1๋ช ์ ๋์๊ฐ๋ฉฐ assignee๋ก ์ง์ ํ๋ค.
์ถ๊ฐ๋ก ์์๋๋ฉด ์ข์ ๊ฒ?
- LGTM (Looks Good To me): ํฌ๊ฒ ๋ฌ ์ฝ๋ฉํธ๊ฐ ์์๋
- NIT(nitpick): ์๋๊ฐ ํฌ๊ฒ ๋ฌด๊ฒ๋ฅผ ๋์ง ์์๋ ๋๋ ํผ๋๋ฐฑ์ผ๋