-
Notifications
You must be signed in to change notification settings - Fork 0
Readme.md
- ํด๊ทผ ์ Feature/?? -> upstream/dev ๋ก pr
- ๋ค์๋ ์์นจ ๋์์ค๋ฉด ๋ฆฌ๋ทฐ + ๋จธ์ง
- ๋ฐฑ๋ก๊ทธ ์์ฑ + ํ ๋น
- forkํ ๋ ํฌ์์ sync(rebase) , ์ ๋ธ๋์น ์์ฑ.
- ๊ธฐ๋ฅ ์ถ๊ฐ ๊ตฌํ. ๋ฐ๋ณต.
-
Main์๋ ํ๋ฆฌํ๋ง ๊ฐ๋ฅํฉ๋๋ค. accept ํ ๊ฒ์. Merge ๋ด๋น : ๋ ธํ์ฑ
-
upstream/dev ์์ origin/dev-๊ธฐ๋ฅ ๋ธ๋์น๋ฅผ ๋ฐ์ - ์์ ์ ํ์๊ณ , upstream/dev์ ํ๋ฆฌํ๋ฅผ ๋ ๋ฆฌ์๋ฉด ๋ฉ๋๋ค.
-
์ฃผ๋ง์ ํธํ ์ฌ๊ธฐ. <- ๊ธํ๋ฉด ๋ค๊ฐ์ด ๊ณ ๋ฏผ์์ข ํด๋ด ์๋ค.
-
1์ฃผ์ผ์ 1๋ฒ์ด์์ ์ง์ฝ๋ฉ(๊ฐ์์ ๋ฌ๋ ํ์์ด ์ด๋์ ๋ ํ์ํฉ๋๋ค.) - ๊ธฐ๋ฅ๋จ์ ์ง์ฝ๋ฉ์ ์งํํ ๊ฑฐ๊ณ , ๋ฏธ๋ฆฌ ์ธ๊ธ์ ์ข ํด์ฃผ๋ฉด ์ข๊ฒ ๋ค.
-
6์ ์ดํ๋ก๋ ๋ณ์ผ์ด ์์ผ๋ฉด ๊ฐ๋จํ ์งํ์ฌํญ ๊ณต์ ํ๊ณ merge๋ฅผ ์งํํ๋ฉด ์ข๊ฒ ๋ค.
-
์์์ผ ์ค์ ์ ์ฝ๋ฉ ์ํด๋ ๋๋, backlog๋ฅผ ์์ธํ๊ฒ ๋ง๋ค์ด ๋ณด์.
-
ํธํ๊ฒ ์ด์ผ๊ธฐ ํ๊ณ , ์ก๋ด์ ๋ง์ด ํฉ์๋ค.
-
์ ์ฒด ๋ ํฌ์งํ ๋ฆฌ์์, readme๋ฅผ ๋งค์ผ ๊ฐฑ์ ํ๋ฉด ์ข์๊ฒ ๊ฐ๋ค - ์คํฌ๋ผ ๋๋๋ฉด ๊ทธ๋ ์ ์ด์ผ๊ธฐ๋ฅผ ๊ธฐ๋กํด ๋์.
- feat, fix, docs, refactor, test
feat : ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ
fix : ๋ฒ๊ทธ ์์
docs : ๋ฌธ์ ์์
refactor : ๋ฆฌํฉํ ๋ง
test : ํ
์คํธ ๊ด๋ จ ์์
eg) feat(AccountController) : ํ์๊ฐ์
์ ์ํ ์ปจํธ๋กค๋ฌ ์ ์
AccountController์ createUser ๋ฉ์๋๋ฅผ ์ถ๊ฐํจ.
- Master
- Develop
- Feature/fe or be/(Feature_name)
- Release/(version_number)
- Hotfix/(Issue_number) or Issue/(Issue_number)
ex) Feature/fe/account
PR title : ์ด์ ๋ฒํธ์ ์ ๋ชฉ ๊ฐ๋ตํ๊ฒ ๋ฃ๊ธฐ
PR body : ํด๊ฒฐํ ๋ฌธ์ ์ ๋ํด์ what, how, why ์์ฑํ๊ธฐ.
- ์ฝ๋๋ฆฌ๋ทฐ ํํ ๋ฆฌ์ผ๋ ํ๋ ๋ง๋ค์ด ์ฃผ๋ฉด ์ข์ ๋ฏ
- road map ์ปค๋ฆฌํ๋ผ์ ๋ง๋ ๊ฐ ๊ณผ์ ์ถ์ฒ
- ๊ต์ก์ ๊ตฌ๋ ํ๋ค
- ๊ฐ๊ฐ์ ๊ณผ์ ์ ์ ๋๋ก ์๋ฃํ๋์ง test
- spoon ๊ฐ๋ฐ์ ๋ง๋ค๊ธฐ ์กฐ๋ฆฝ์ ๊ฐ๋ฐ์ ๋ง๋ค๊ธฐ
- ์ฃผ ๊ฐ์๋ค์ ์๋๊ฑฐ ์๋๋ฉด, ๋ก๋๋งต์์ ๋ฐ์ค๊ณ , ๊ณผ์ ๋ฅผ ๋ง๋ค์ด์ ์ ๊ณต์ ํฉ๋๋ค. ์ดํ ์ฝ๋๋ฆฌ๋ทฐ๋ฅผ ์ ๋ฃ๋ก ๋ฐ์ ์ ์์ต๋๋ค. 3์ผ? ๋จ์์ ๋๋ก ๋ชจ์์ ํผ์ด๋ฆฌ๋ทฐ.
์ถ์์ฒดํฌ๋ ํด์ฃผ๊ณ , ์์๋ ์ข ํด์ฃผ๋ฉด ์ข์๋ฏ ํฉ๋๋ค.
- ๋ก๋๋งต ๋ณด์ฌ์ฃผ๊ธฐ
- ์๊ฐ ๋ฐฉ๋ฒ ์ ํํ๊ธฐ
- ๊ณผ์ ์ ์ถ ํ๋ฉด
- ๋ก๊ทธ์ธ
- ์ ์ ๊ฐ ์น์ฌ์ดํธ์ ์ ๊ทผํด์, ๋๋ ๊ฐ๋ฐ์๊ฐ ๋๊ณ ์ถ์ด์ ๋ฒํผ์ ๋๋ฅธ๋ค. or ๋ก๊ทธ์ธ
- ํ์๊ฐ์ ์งํ ์ ์ฐจ๋ฅผ ์ค๋ฌธ์กฐ์ฌ ์ดํ๋ก ์ค์ ํ์๊ธฐ ๋๋ฌธ์ ๋ก๊ทธ์ธ์ ์งํํ๋ฉด ๋ฌด์กฐ๊ฑด ๋ก๋๋งต์ด ์กด์ฌํ๋ค.
2-1. ๋ก๊ทธ์ธ์ ์งํ ํ์์ ๊ฒฝ์ฐ.
2-2. ๋ก๊ทธ์ธ์ ์งํํ์ง ์์์ ๊ฒฝ์ฐ
2-2-1. ์ค๋ฌธ์กฐ์ฌ๋ฅผ ์งํ. ์ค๋ฌธ์กฐ์ฌ [doc ๋งํฌ]
2-2-2. ํ์ ๊ฐ์
- ๋ก๋๋งต ์์ฑ ์งํ
- ๋ก๋๋งต์ ์ค๋ฌธ์กฐ์ฌ์ ๋ฐ๋ผ ๋ฏธ๋ฆฌ ์์ฑ๋ ๋ก๋๋งต์ ์ฌ์ฉ์์ ๋ง๊ฒ ๋ณด์ฌ์ฃผ๋ ํํ.
- ๋ก๋๋งต ์ค์ ๊ธฐ์ค : ์์๋๋ก ์์ฑ. ** 1. ์ฝ๋ฉ๊ฒฝํ(์์ค) - ์ด ์ค ๊ณ ** 2. ์ง๊ตฐ ** 3. ์ธ์ด ** 4. ํ๋ ์ ์ํฌ
3.1 ๊ณผ์ ์ข ๋ฅ
- 1๋1 ๊ฐ์ฌ (์์ฒด ์๋น์ค)
- 1๋๋ค ํ์(์ธํ๋ฐ ๋ฑ ์ ๋ฃ ๊ฐ์ ๋ค๊ณ ์ค๊ธฐ.)
- ์จ๋ผ์ธ ๊ฐ์(๋ฌด๋ฃ) ๋ฅผ ๋ณด๊ณ ์ฑํฐ๋ณ ๊ณผ์ ๋ฅผ ์ ๊ณต(์์ฒด ์๋น์ค)
- ๋ก๋๋งต ๊ธฐ๋ฅ
-
๋ก๋๋งต์ ํฌ๊ฒ ๊ณผ์ , ๊ณผ๋ชฉ, ๊ณผ๋ชฉ ๋ด์ chapter ์กด์ฌ.
-
์์ฑํฐ ๋ณ๋ก ๊ฐ๋จํ ๊ณผ์ ๋ฅผ ๋ฐ๊ณ ํผ๋๋ฐฑ์ ์งํ. ** ํผ๋๋ฐฑ ๋ฐฉ๋ฒ : ** 1. ๊ฐ์ฌ์ ๊ฒฝ์ฐ, 1๋1 ์ฝ๋๋ฆฌ๋ทฐ( ์์ฒด ์๋น์ค ) ** 2. ํ์์ ๊ฒฝ์ฐ, ํ์ ๋จ์์ ์ฝ๋๋ฆฌ๋ทฐ ์งํ ** 3. ์จ๋ผ์ธ ๊ฐ์์ ๊ฒฝ์ฐ, ํผ์ด ๋ฆฌ๋ทฐ ( ์์ฒด ์๋น์ค ) ์งํ ๊ฐ๋ฅ. ์ ๋ฃ ์๋น์ค๋ก ๊ฐ์ฌํํ ์ฝ๋๋ฆฌ๋ทฐ๋ฅผ ๋ฐ์ ์ ์๊ฒ ํด์ค๋ค.
-
๊ณผ๋ชฉ ๋ณ๋ก test ์งํ ex) ๊ธฐ์ดํ๋ก๊ทธ๋๋ฐ -test- python -test- ์ฅ๊ณ
-
๊ฐ ๊ณผ๋ชฉ๋ณ๋ก ํ ์คํธ๋ฅผ ์งํํ์ฌ ๊ต์ก์ด ์ ๋๋ก ์งํ๋ฌ๋์ง ํ์ธ ๊ฐ๋ฅ.
- ๊ตฌ๊ธ docs ์ฐ๋
- ์์ ๋ก๊ทธ์ธ ( OAUTH )
- ํ์ฌ ๋ก๋๋งต ๋ฐฉ๋ฒ์ด 3๊ฐ์ง์ธ๋ฐ, ์ด ์ค 2,3 ์ฐ์ ๊ฐ๋ฐ.
- ๊ณผ์ ๊ฐ ์๋ฃ๋์์ด์! ๊ฐ์ ์๋ฆผ์ ์น-> ์นด์นด์คํก์ผ๋ก ๋ณด๋ด์ฃผ๋ api ์ฐ๋๋ ํด๋ณด๋ฉด ์ด๋จ๊น?
- ์งํ ์ํฉ์ ๋ฐ๋ผ ์ ์ด ๋๋ฅผ ๋ง๋ค๋ ํ ์๋ฒ์ง์ ๋ชจ์ ์ ๋ฐ๊พธ๊ฒ