Skip to content

Readme.md

July_6 edited this page Feb 2, 2023 · 17 revisions

Ground Rule

woking logic

  • ํ‡ด๊ทผ ์ „ Feature/?? -> upstream/dev ๋กœ pr
  • ๋‹ค์Œ๋‚  ์•„์นจ ๋Œ์•„์˜ค๋ฉด ๋ฆฌ๋ทฐ + ๋จธ์ง€
  • ๋ฐฑ๋กœ๊ทธ ์ƒ์„ฑ + ํ• ๋‹น
  • forkํ•œ ๋ ˆํฌ์—์„œ sync(rebase) , ์ƒˆ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ.
  • ๊ธฐ๋Šฅ ์ถ”๊ฐ€ ๊ตฌํ˜„. ๋ฐ˜๋ณต.

other rules

  • Main์—๋Š” ํ’€๋ฆฌํ€˜๋งŒ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. accept ํ• ๊ฒŒ์š”. Merge ๋‹ด๋‹น : ๋…ธํ˜„์šฑ

  • upstream/dev ์—์„œ origin/dev-๊ธฐ๋Šฅ ๋ธŒ๋žœ์น˜๋ฅผ ๋”ฐ์„œ - ์ž‘์—…์„ ํ•˜์‹œ๊ณ , upstream/dev์— ํ’€๋ฆฌํ€˜๋ฅผ ๋‚ ๋ฆฌ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

  • ์ฃผ๋ง์—” ํŽธํžˆ ์‰ฌ๊ธฐ. <- ๊ธ‰ํ•˜๋ฉด ๋‹ค๊ฐ™์ด ๊ณ ๋ฏผ์„์ข€ ํ•ด๋ด…์‹œ๋‹ค.

  • 1์ฃผ์ผ์— 1๋ฒˆ์ด์ƒ์€ ์ง์ฝ”๋”ฉ(๊ฐ์ž์˜ ๋Ÿฌ๋‹ ํƒ€์ž„์ด ์–ด๋Š์ •๋„ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.) - ๊ธฐ๋Šฅ๋‹จ์œ„ ์ง์ฝ”๋”ฉ์„ ์ง„ํ–‰ํ• ๊ฑฐ๊ณ , ๋ฏธ๋ฆฌ ์–ธ๊ธ‰์„ ์ข€ ํ•ด์ฃผ๋ฉด ์ข‹๊ฒ ๋‹ค.

  • 6์‹œ ์ดํ›„๋กœ๋Š” ๋ณ„์ผ์ด ์—†์œผ๋ฉด ๊ฐ„๋‹จํžˆ ์ง„ํ–‰์‚ฌํ•ญ ๊ณต์œ ํ•˜๊ณ  merge๋ฅผ ์ง„ํ–‰ํ•˜๋ฉด ์ข‹๊ฒ ๋‹ค.

  • ์›”์š”์ผ ์˜ค์ „์€ ์ฝ”๋”ฉ ์•ˆํ•ด๋„ ๋˜๋‹ˆ, backlog๋ฅผ ์ƒ์„ธํ•˜๊ฒŒ ๋งŒ๋“ค์–ด ๋ณด์ž.

  • ํŽธํ•˜๊ฒŒ ์ด์•ผ๊ธฐ ํ•˜๊ณ , ์žก๋‹ด์„ ๋งŽ์ด ํ•ฉ์‹œ๋‹ค.

  • ์ „์ฒด ๋ ˆํฌ์ง€ํ† ๋ฆฌ์—์„œ, readme๋ฅผ ๋งค์ผ ๊ฐฑ์‹ ํ•˜๋ฉด ์ข‹์„๊ฒƒ ๊ฐ™๋‹ค - ์Šคํฌ๋Ÿผ ๋๋‚˜๋ฉด ๊ทธ๋‚ ์˜ ์ด์•ผ๊ธฐ๋ฅผ ๊ธฐ๋กํ•ด ๋‘์ž.

Commit Rules

  • feat, fix, docs, refactor, test
feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
fix : ๋ฒ„๊ทธ ์ˆ˜์ •
docs : ๋ฌธ์„œ ์ˆ˜์ •
refactor : ๋ฆฌํŒฉํ† ๋ง
test : ํ…Œ์ŠคํŠธ ๊ด€๋ จ ์ˆ˜์ •

eg) feat(AccountController) : ํšŒ์›๊ฐ€์ž…์„ ์œ„ํ•œ ์ปจํŠธ๋กค๋Ÿฌ ์ œ์ž‘
    AccountController์— createUser ๋ฉ”์†Œ๋“œ๋ฅผ ์ถ”๊ฐ€ํ•จ.

Branch Rules

- Master
- Develop
- Feature/fe or be/(Feature_name)
- Release/(version_number)
- Hotfix/(Issue_number) or Issue/(Issue_number)

ex) Feature/fe/account

PR Rules

PR title : ์ด์Šˆ ๋ฒˆํ˜ธ์™€ ์ œ๋ชฉ ๊ฐ„๋žตํ•˜๊ฒŒ ๋„ฃ๊ธฐ
PR body : ํ•ด๊ฒฐํ•œ ๋ฌธ์ œ์— ๋Œ€ํ•ด์„œ what, how, why ์ž‘์„ฑํ•˜๊ธฐ.

Basic Ideas

  1. ์ฝ”๋“œ๋ฆฌ๋ทฐ ํŠœํ† ๋ฆฌ์–ผ๋„ ํ•˜๋‚˜ ๋งŒ๋“ค์–ด ์ฃผ๋ฉด ์ข‹์„ ๋“ฏ
  2. road map ์ปค๋ฆฌํ˜๋Ÿผ์— ๋งž๋Š” ๊ฐ ๊ณผ์ • ์ถ”์ฒœ
  3. ๊ต์œก์„ ๊ตฌ๋…ํ•œ๋‹ค
  4. ๊ฐ๊ฐ์˜ ๊ณผ์ •์„ ์ œ๋Œ€๋กœ ์ˆ˜๋ฃŒํ–ˆ๋Š”์ง€ test
  5. spoon ๊ฐœ๋ฐœ์ž ๋งŒ๋“ค๊ธฐ ์กฐ๋ฆฝ์‹ ๊ฐœ๋ฐœ์ž ๋งŒ๋“ค๊ธฐ
  6. ์ฃผ ๊ฐ•์˜๋“ค์€ ์•„๋Š”๊ฑฐ ์•„๋‹ˆ๋ฉด, ๋กœ๋“œ๋งต์—์„œ ๋”ฐ์˜ค๊ณ , ๊ณผ์ œ๋ฅผ ๋งŒ๋“ค์–ด์„œ ์ œ๊ณต์„ ํ•ฉ๋‹ˆ๋‹ค. ์ดํ›„ ์ฝ”๋“œ๋ฆฌ๋ทฐ๋ฅผ ์œ ๋ฃŒ๋กœ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. 3์ผ? ๋‹จ์œ„์ •๋„๋กœ ๋ชจ์•„์„œ ํ”ผ์–ด๋ฆฌ๋ทฐ.

๋งˆ์ด๋„ˆ ๊ธฐ๋Šฅ๋“ค

์ถœ์„์ฒดํฌ๋„ ํ•ด์ฃผ๊ณ , ์‘์›๋„ ์ข€ ํ•ด์ฃผ๋ฉด ์ข‹์„๋“ฏ ํ•ฉ๋‹ˆ๋‹ค.

SPRINT ์ •ํ•˜๊ธฐ - 1์ฃผ์ฐจ

  • ๋กœ๋“œ๋งต ๋ณด์—ฌ์ฃผ๊ธฐ
  • ์ˆ˜๊ฐ• ๋ฐฉ๋ฒ• ์„ ํƒํ•˜๊ธฐ
  • ๊ณผ์ œ ์ œ์ถœ ํ™”๋ฉด
  • ๋กœ๊ทธ์ธ

ํŒ€๋ช… ์ •ํ•˜๊ธฐ

devroad ๋กœ ํ™•์ •. ๋งˆ์น˜ ๋„ค์ด๋ฒ„

์‹œ๋‚˜๋ฆฌ์˜ค

  1. ์œ ์ €๊ฐ€ ์›น์‚ฌ์ดํŠธ์— ์ ‘๊ทผํ•ด์„œ, ๋‚˜๋„ ๊ฐœ๋ฐœ์ž๊ฐ€ ๋˜๊ณ ์‹ถ์–ด์š” ๋ฒ„ํŠผ์„ ๋ˆ„๋ฅธ๋‹ค. or ๋กœ๊ทธ์ธ
  • ํšŒ์›๊ฐ€์ž… ์ง„ํ–‰ ์ ˆ์ฐจ๋ฅผ ์„ค๋ฌธ์กฐ์‚ฌ ์ดํ›„๋กœ ์„ค์ •ํ•˜์˜€๊ธฐ ๋•Œ๋ฌธ์— ๋กœ๊ทธ์ธ์„ ์ง„ํ–‰ํ•˜๋ฉด ๋ฌด์กฐ๊ฑด ๋กœ๋“œ๋งต์ด ์กด์žฌํ•œ๋‹ค.

2-1. ๋กœ๊ทธ์ธ์„ ์ง„ํ–‰ ํ•˜์˜€์„ ๊ฒฝ์šฐ.

2-2. ๋กœ๊ทธ์ธ์„ ์ง„ํ–‰ํ•˜์ง€ ์•Š์•˜์„ ๊ฒฝ์šฐ

2-2-1. ์„ค๋ฌธ์กฐ์‚ฌ๋ฅผ ์ง„ํ–‰. ์„ค๋ฌธ์กฐ์‚ฌ [doc ๋งํฌ]

2-2-2. ํšŒ์› ๊ฐ€์ž…

  1. ๋กœ๋“œ๋งต ์ƒ์„ฑ ์ง„ํ–‰
  • ๋กœ๋“œ๋งต์€ ์„ค๋ฌธ์กฐ์‚ฌ์— ๋”ฐ๋ผ ๋ฏธ๋ฆฌ ์ƒ์„ฑ๋œ ๋กœ๋“œ๋งต์„ ์‚ฌ์šฉ์ž์— ๋งž๊ฒŒ ๋ณด์—ฌ์ฃผ๋Š” ํ˜•ํƒœ.
  • ๋กœ๋“œ๋งต ์„ค์ • ๊ธฐ์ค€ : ์ˆœ์„œ๋Œ€๋กœ ์ž‘์„ฑ. ** 1. ์ฝ”๋”ฉ๊ฒฝํ—˜(์ˆ˜์ค€) - ์ดˆ ์ค‘ ๊ณ  ** 2. ์ง๊ตฐ ** 3. ์–ธ์–ด ** 4. ํ”„๋ ˆ์ž„ ์›Œํฌ

3.1 ๊ณผ์ • ์ข…๋ฅ˜

  • 1๋Œ€1 ๊ฐ•์‚ฌ (์ž์ฒด ์„œ๋น„์Šค)
  • 1๋Œ€๋‹ค ํ•™์›(์ธํ”„๋Ÿฐ ๋“ฑ ์œ ๋ฃŒ ๊ฐ•์˜ ๋“ค๊ณ ์˜ค๊ธฐ.)
  • ์˜จ๋ผ์ธ ๊ฐ•์˜(๋ฌด๋ฃŒ) ๋ฅผ ๋ณด๊ณ  ์ฑ•ํ„ฐ๋ณ„ ๊ณผ์ œ๋ฅผ ์ œ๊ณต(์ž์ฒด ์„œ๋น„์Šค)
  1. ๋กœ๋“œ๋งต ๊ธฐ๋Šฅ
  • ๋กœ๋“œ๋งต์€ ํฌ๊ฒŒ ๊ณผ์ •, ๊ณผ๋ชฉ, ๊ณผ๋ชฉ ๋‚ด์˜ chapter ์กด์žฌ.

  • ์†Œ์ฑ•ํ„ฐ ๋ณ„๋กœ ๊ฐ„๋‹จํ•œ ๊ณผ์ œ๋ฅผ ๋ฐ›๊ณ  ํ”ผ๋“œ๋ฐฑ์„ ์ง„ํ–‰. ** ํ”ผ๋“œ๋ฐฑ ๋ฐฉ๋ฒ• : ** 1. ๊ฐ•์‚ฌ์˜ ๊ฒฝ์šฐ, 1๋Œ€1 ์ฝ”๋“œ๋ฆฌ๋ทฐ( ์ž์ฒด ์„œ๋น„์Šค ) ** 2. ํ•™์›์˜ ๊ฒฝ์šฐ, ํ•™์› ๋‹จ์—์„œ ์ฝ”๋“œ๋ฆฌ๋ทฐ ์ง„ํ–‰ ** 3. ์˜จ๋ผ์ธ ๊ฐ•์˜์˜ ๊ฒฝ์šฐ, ํ”ผ์–ด ๋ฆฌ๋ทฐ ( ์ž์ฒด ์„œ๋น„์Šค ) ์ง„ํ–‰ ๊ฐ€๋Šฅ. ์œ ๋ฃŒ ์„œ๋น„์Šค๋กœ ๊ฐ•์‚ฌํ•œํ…Œ ์ฝ”๋“œ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ›์„ ์ˆ˜ ์žˆ๊ฒŒ ํ•ด์ค€๋‹ค.

  • ๊ณผ๋ชฉ ๋ณ„๋กœ test ์ง„ํ–‰ ex) ๊ธฐ์ดˆํ”„๋กœ๊ทธ๋ž˜๋ฐ -test- python -test- ์žฅ๊ณ 

  • ๊ฐ ๊ณผ๋ชฉ๋ณ„๋กœ ํ…Œ์ŠคํŠธ๋ฅผ ์ง„ํ–‰ํ•˜์—ฌ ๊ต์œก์ด ์ œ๋Œ€๋กœ ์ง„ํ–‰๋ฌ๋Š”์ง€ ํ™•์ธ ๊ฐ€๋Šฅ.

๋„์ „ ์š”์†Œ

  • ๊ตฌ๊ธ€ docs ์—ฐ๋™
  • ์†Œ์…œ ๋กœ๊ทธ์ธ ( OAUTH )
  • ํ˜„์žฌ ๋กœ๋“œ๋งต ๋ฐฉ๋ฒ•์ด 3๊ฐ€์ง€์ธ๋ฐ, ์ด ์ค‘ 2,3 ์šฐ์„  ๊ฐœ๋ฐœ.
  • ๊ณผ์ œ๊ฐ€ ์™„๋ฃŒ๋˜์—ˆ์–ด์š”! ๊ฐ™์€ ์•Œ๋ฆผ์„ ์›น-> ์นด์นด์˜คํ†ก์œผ๋กœ ๋ณด๋‚ด์ฃผ๋Š” api ์—ฐ๋™๋„ ํ•ด๋ณด๋ฉด ์–ด๋–จ๊นŒ?
  • ์ง„ํ–‰ ์ƒํ™ฉ์— ๋”ฐ๋ผ ์‹ ์ด ๋‚˜๋ฅผ ๋งŒ๋“ค๋•Œ ํ• ์•„๋ฒ„์ง€์˜ ๋ชจ์…˜์„ ๋ฐ”๊พธ๊ฒŒ