Skip to content

Collaboration strategy ๐Ÿ“

yeriinnn edited this page Feb 26, 2024 · 7 revisions

Commit Convention

[์ง๋ฌด] ํƒœ๊ทธ: ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ 

์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ Body์—๋Š” ๋” ์ž์„ธํ•œ ๋‚ด์šฉ์„ ์ ์–ด์ฃผ์„ธ์š”
# ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์€ ํ•œ๊ตญ์–ด๋กœ ํ•œ๋‹ค
# ์ œ๋ชฉ๊ณผ ๋ถ„๋ฌธ์„ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌํ•œ๋‹ค
# ๋ณธ๋ฌธ์—๋Š” "์–ด๋–ป๊ฒŒ" ๋ณด๋‹ค๋Š” "๋ฌด์—‡์„", "์™œ" ์— ๋Œ€ํ•ด ์„ค๋ช…ํ•œ๋‹ค
# ์ œ๋ชฉ์€ ๋ฌธ์žฅ์ด ์•„๋‹Œ ๋‹จ์–ด๋กœ ๋๋งบ์Œํ•œ๋‹ค (ex: ~ ๊ธฐ๋Šฅ ๊ตฌํ˜„)
# ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€

Resolves: #ํ•ด๊ฒฐํ•œ ์ด์Šˆ๋ฒˆํ˜ธ
Ref: #์ฐธ๊ณ ํ•  ์ด์Šˆ๋ฒˆํ˜ธ
Related to: #์˜ํ–ฅ์„ ๋ฐ›๋Š” ์ด์Šˆ๋ฒˆํ˜ธ
์ง๋ฌด ์„ค๋ช…
Android ์•ˆ๋“œ๋กœ์ด๋“œ
BE ๋ฐฑ์—”๋“œ
TEAM ์ „์ฒด
ํƒœ๊ทธ ์„ค๋ช…
feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•œ ๊ฒฝ์šฐ
fix: ๋ฒ„๊ทธ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ
style: ๊ธฐ๋Šฅ๊ณผ ๊ด€๋ จ๋œ ์ฝ”๋“œ ๋ณ€๊ฒฝ ์—†์ด ์Šคํƒ€์ผ์ด ๋ณ€๊ฒฝ๋œ ๊ฒฝ์šฐ, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์˜คํƒ€ ์ˆ˜์ •
refactor: ๊ธฐ๋Šฅ๊ณผ ๊ด€๋ จ๋œ ์ฝ”๋“œ ์ˆ˜์ •, ํƒ€์ž… ๋˜๋Š” ๋ณ€์ˆ˜๋ช… ๋ณ€๊ฒฝ
comment: ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
docs: ๋ฌธ์„œ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ
test: ํ…Œ์ŠคํŠธ ์ถ”๊ฐ€, ํ…Œ์ŠคํŠธ ๋ฆฌํŒฉํ† ๋ง
chore: ๊ธฐ๋ณธ ์„ธํŒ… ๋ฐ ๋นŒ๋“œ ๊ด€๋ จ ์—…๋ฐ์ดํŠธ
remove: ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
deploy: ๋ฐฐํฌ ๊ด€๋ จ ์ž‘์—…์„ ์ง„ํ–‰ํ•œ ๊ฒฝ์šฐ

Issue Convention

  • MainFeature์™€ SubFeature๋กœ ๋‚˜๋ˆ„์–ด ์ด์Šˆ ๋ฐœํ–‰
  • fix์™€ refactor ๊ด€๋ จํ•˜์—ฌ ๋ณ„๋„์˜ ์ด์Šˆ ํ…œํ”Œ๋ฆฟ์„ ์ด์šฉํ•ด ๋ฐœํ–‰

01) MainFeature

---
name: Issue Request
about: ์ด์Šˆ ํ…œํ”Œ๋ฆฟ
title: "[Domain] ํƒœ๊ทธ : ์ด์Šˆ์ œ๋ชฉ"
labels: ''
assignees: ''
---

## ๐Ÿ’โ€โ™‚๏ธ Feature ์ •์˜

> ์ถ”๊ฐ€ํ•˜๋ ค๋Š” Feature ์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์ •์˜ํ•ด์ฃผ์„ธ์š”
ex) ํšŒ์›๊ฐ€์ž…

## ๐Ÿ“ ์„œ๋ธŒ ISSUE List

### AOS
- [ ] TODO #์ด์Šˆ๋ฒˆํ˜ธ
- [ ] TODO #์ด์Šˆ๋ฒˆํ˜ธ

### BE
- [ ] TODO #์ด์Šˆ๋ฒˆํ˜ธ
- [ ] TODO #์ด์Šˆ๋ฒˆํ˜ธ


## ๐Ÿ”— ์ฐธ๊ณ ํ• ๋งŒํ•œ ์ž๋ฃŒ(์„ ํƒ) 

02) SubFeature

---
name: Issue Request
about: ์ด์Šˆ ํ…œํ”Œ๋ฆฟ
title: "[์ง๋ฌด][Domain] ํƒœ๊ทธ: ์ด์Šˆ์ œ๋ชฉ"
labels: ''
assignees: ''
---

## ๐Ÿ’โ€โ™‚๏ธ ์–ด๋–ค ๊ธฐ๋Šฅ์ธ๊ฐ€์š”?
> ์ถ”๊ฐ€ํ•˜๋ ค๋Š” ๊ธฐ๋Šฅ์— ๋Œ€ํ•ด ๊ฐ„๊ฒฐํ•˜๊ฒŒ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”

## ๐Ÿ“ ์ž‘์—… ์ƒ์„ธ ๋‚ด์šฉ

- [ ] TODO
- [ ] TODO

## ๐Ÿ”— ์ฐธ๊ณ ํ• ๋งŒํ•œ ์ž๋ฃŒ(์„ ํƒ)

03) Fix Convention

---
name: Issue Request
about: ์ด์Šˆ ํ…œํ”Œ๋ฆฟ
title: "[์ง๋ฌด][Domain] ํƒœ๊ทธ: ์ด์Šˆ์ œ๋ชฉ"
labels: ''
assignees: ''
---

## ๐Ÿœ ์–ด๋–ค ๋ฒ„๊ทธ์ธ๊ฐ€์š”?

> ์–ด๋–ค ๋ฒ„๊ทธ์ธ์ง€ ๊ฐ„๊ฒฐํ•˜๊ฒŒ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”

## ๐Ÿ†˜ ์–ด๋–ค ์ƒํ™ฉ์—์„œ ๋ฐœ์ƒํ•œ ๋ฒ„๊ทธ์ธ๊ฐ€์š”? (as-is)

> (๊ฐ€๋Šฅํ•˜๋ฉด) Given-When-Then ํ˜•์‹์œผ๋กœ ์„œ์ˆ ํ•ด์ฃผ์„ธ์š”

## ๐Ÿ“ฃ ์˜ˆ์ƒ ๊ฒฐ๊ณผ (to-be)

> ์˜ˆ์ƒํ–ˆ๋˜ ์ •์ƒ์ ์ธ ๊ฒฐ๊ณผ๊ฐ€ ์–ด๋–ค ๊ฒƒ์ด์—ˆ๋Š”์ง€ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”
> ์ถ”๊ฐ€์ ์œผ๋กœ ๋ฒ„๊ทธ๋กœ ์ง์ž‘๋˜๋Š” ์ด์œ ๊ฐ€ ์žˆ๋‹ค๋ฉด ๊ฐ™์ด ์ ์–ด์ฃผ์„ธ์š”

## ๐Ÿ”— ์ฐธ๊ณ ํ• ๋งŒํ•œ ์ž๋ฃŒ(์„ ํƒ)

> ์Šคํฌ๋ฆฐ์ƒท์ด๋‚˜ ๊ธฐ๋Šฅ ๋“ฑ ์ถ”๊ฐ€ ์ž๋ฃŒ๋ฅผ ๊ธฐ์ˆ ํ•ด ์ฃผ์„ธ์š”

04) Refactor Convention

---
name: Issue Request
about: ์ด์Šˆ ํ…œํ”Œ๋ฆฟ
title: "[์ง๋ฌด][Domain] ํƒœ๊ทธ: ์ด์Šˆ์ œ๋ชฉ"
labels: ''
assignees: ''
---

## โš™๏ธ ๊ฐœ์„ ํ•ด์•ผ ๋˜๋Š” ์ฝ”๋“œ ํ˜น์€ ๊ธฐ๋Šฅ์— ๋Œ€ํ•ด์„œ ์ ์–ด์ฃผ์„ธ์š”

> ๊ฐœ์„ ํ•ด์•ผ ๋  ์ฝ”๋“œ์— ๋Œ€ํ•œ ๋ช…ํ™•ํ•˜๊ณ  ๊ฐ„๋‹จํ•œ ์„ค๋ช…

## ๐Ÿ› ๏ธ ์›ํ•˜๋Š” ๊ฐœ์„  ๋ฐฉํ–ฅ

> ๊ฐœ์„ ํ•ด์•ผ ๋˜๋Š” ๊ฐ„๋‹จํ•œ ์ด์œ  ํ˜น์€ ๊ฐœ์„  ํ›„ ์žฅ์ ์— ๋Œ€ํ•ด ์ ์–ด์ฃผ์„ธ์š”

## ๐Ÿ”ง ์ƒ๊ฐ ์ค‘์ธ ๊ธฐ๋Šฅ ์ถ”๊ฐ€ ๋ฐฉ์•ˆ

> ํ•ด๊ฒฐ์ฑ…์œผ๋กœ ๊ฐ„๋‹จํ•˜๊ฒŒ ์ƒ๊ฐํ•œ ๊ฐœ์„  ๋ฐฉ๋ฒ•์— ๋Œ€ํ•ด ์ ์–ด์ฃผ์„ธ์š”

## ๐Ÿ”— ETC

> ์Šคํฌ๋ฆฐ์ƒท์ด๋‚˜ ๊ธฐ๋Šฅ ๋“ฑ ์ถ”๊ฐ€ ์ž๋ฃŒ๋ฅผ ๊ธฐ์ˆ ํ•ด ์ฃผ์„ธ์š”

PR Convention

[์ง๋ฌด][Domain] ํƒœ๊ทธ: PR์ œ๋ชฉ
## #๏ธโƒฃ ์—ฐ๊ด€๋œ ์ด์Šˆ
> ex) #์ด์Šˆ๋ฒˆํ˜ธ, #์ด์Šˆ๋ฒˆํ˜ธ

## ๐Ÿ“ ์ž‘์—… ๋‚ด์šฉ
> ์ด๋ฒˆ PR์—์„œ ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ ๊ฐ„๋žตํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”(์ด๋ฏธ์ง€ ์ฒจ๋ถ€ ๊ฐ€๋Šฅ)

### ์Šคํฌ๋ฆฐ์ƒท (์„ ํƒ)

## ๐Ÿ’ฌ ๋ฆฌ๋ทฐ ์š”๊ตฌ์‚ฌํ•ญ(์„ ํƒ)
> ๋ฆฌ๋ทฐ์–ด๊ฐ€ ํŠน๋ณ„ํžˆ ๋ด์ฃผ์—ˆ์œผ๋ฉด ํ•˜๋Š” ๋ถ€๋ถ„์ด ์žˆ๋‹ค๋ฉด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”
>
> ex) ๋ฉ”์„œ๋“œ XXX์˜ ์ด๋ฆ„์„ ๋” ์ž˜ ์ง“๊ณ  ์‹ถ์€๋ฐ ํ˜น์‹œ ์ข‹์€ ๋ช…์นญ์ด ์žˆ์„๊นŒ์š”?

Branch Strategy

๋ธŒ๋žœ์น˜ ์—ญํ• 
main ๋ฐฐํฌ๋ฅผ ์œ„ํ•œ ๋ธŒ๋žœ์น˜
dev ๊ธฐ๋Šฅ ํ†ตํ•ฉ์„ ์œ„ํ•œ ๋ธŒ๋žœ์น˜
01) dev -> main merge : create merge commit
02) ์ถฉ๋Œ์—ฌ๋ถ€ ํ™•์ธ ํ›„ merge
03) merge๋œ ํ›„ main -> dev fetch
์ง๋ฌด/feat/#์ด์Šˆ๋ฒˆํ˜ธ
ex) be/feat/#1
์ž‘์—…์„ ์œ„ํ•œ ๋ธŒ๋žœ์น˜
- ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋˜๋Š” ๋ฒ„๊ทธ ์ˆ˜์ •
- dev -> feat ๋ถ„๊ธฐ
- feat -> dev merge
- PR ํ›„ ์ฝ”๋“œ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ›์€ ํ›„ ๋ณธ์ธ ๋ธŒ๋žœ์น˜๋Š” ๋ณธ์ธ์ด merge
- merge๋œ ํ›„ feat ๋ธŒ๋žœ์น˜๋Š” ๋ฐ”๋กœ ์‚ญ์ œ
์ง๋ฌด/hotfix/#์ด์Šˆ๋ฒˆํ˜ธ ๋ฐฐํฌ๋œ ๋ฒ„์ „์—์„œ ๋ฐœ์ƒํ•œ ๋ฒ„๊ทธ์— ๋Œ€ํ•ด ๊ธด๊ธ‰ ์ˆ˜์ •ํ•˜๊ธฐ ์œ„ํ•œ ๋ธŒ๋žœ์น˜
main -> hotfix ๋ถ„๊ธฐ

๐Ÿ€ Home

๐Ÿ’ป Sources

๐Ÿ“ Rules

๐Ÿ—‚ Sprint

  • 1์ฃผ์ฐจ ์Šคํ”„๋ฆฐํŠธ ๐ŸŒฑ
  • 2์ฃผ์ฐจ ์Šคํ”„๋ฆฐํŠธ ๐ŸŒฟ
  • 3์ฃผ์ฐจ ์Šคํ”„๋ฆฐํŠธ ๐ŸŒณ
  • โ˜€ Scrums

    1์ฃผ์ฐจ
    2์ฃผ์ฐจ
    3์ฃผ์ฐจ
    4์ฃผ์ฐจ
    5์ฃผ์ฐจ

    ๐ŸŒ™ Reviews

    1์ฃผ์ฐจ
    2์ฃผ์ฐจ
    3์ฃผ์ฐจ
    4์ฃผ์ฐจ
    5์ฃผ์ฐจ

    โœ Tech Posts & Mini seminar

    โœจ [BE]

    โœจ [Android]

    Clone this wiki locally