Ground Rules - boostcamp-2020/Project03-A-TOTP GitHub Wiki

Ground Rules

๋ชฉ์ฐจ

1. ํ•จ๊ป˜ํ•˜๋Š” ํ™œ๋™

1. 1. ์Šคํฌ๋Ÿผ

  • ์•„์นจ๋งˆ๋‹ค ์˜ค์ „ 10์‹œ HackMD๋ฅผ ์ผœ์„œ ๊ฐ์ž์˜ ๋‚ด์šฉ์„ ์ž‘์„ฑ
    • ์–ด์ œ ํ–ˆ๋˜ ์ผ,์ปจ๋””์…˜, ์˜ค๋Š˜ ํ•  ์ผ
  • ์ž‘์„ฑ ์™„๋ฃŒํ›„ Wiki ์Šคํฌ๋Ÿผ ํŽ˜์ด์ง€์— ์—…๋กœ๋“œ

1. 2. ํšŒ๊ณ 

  • ๋งค์ผ 6์‹œ 45๋ถ„์— ๋งŒ๋‚˜์„œ ํ•จ๊ป˜ ํšŒ๊ณ ๋ก ์ž‘์„ฑ
  • ๊ฐœ๋ฐœ์ผ์ง€ + ๊ฐœ์ธํšŒ๊ณ 
    • ๊ทธ๋‚  ๊ฐœ๋ฐœํ•œ ๋‚ด์šฉ, ์–ด๋ ค์› ๋˜ ์ , ํ•ด๊ฒฐ ๊ณผ์ • ๊ธฐ๋ก
    • ์˜ค๋Š˜ ํ•˜๋ฃจ๋ฅผ ์–ด๋–ป๊ฒŒ ๋ณด๋ƒˆ๋Š”์ง€ ์†Œ๊ฐ ๊ธฐ๋ก
    • ์ž˜ํ•œ ์ ์ด ์žˆ์œผ๋ฉด ์Šค์Šค๋กœ ์นญ์ฐฌํ•ด์ฃผ๊ณ , ๋ถ€์กฑํ•œ ์ ์€ ๊ฐœ์„ ์ ์„ ์ƒ๊ฐํ•ด๋ณด๊ธฐ

1. 3. ์˜คํ”„๋ผ์ธ & ์˜จ๋ผ์ธ ํšŒ์˜

  • ์‹œ๊ฐ„ : ์›”์š”์ผ
  • ์žฅ์†Œ : ์ˆญ์‹ค๋Œ€

2. Git

2. 1. Issue

  • Backlog ์ž‘์„ฑ
  • Label : BE, FE, Common
  • Milestone : ๊ธฐ๋Šฅ๋ณ„ ๋ชฉํ‘œ (์ฒ˜์Œ 2์ฃผ, ์ด ํ›„ 1์ฃผ)
  • Kanban(Projects) : Back, Front
    • Issue(To do) -> In Progress -> Done -> Merged
  • ์ž‘์„ฑ๋ฐฉ๋ฒ•
    • ์Šคํฌ๋Ÿผ ๋๋‚˜๊ณ  ๋ณธ์ธ์˜ ์˜ค๋Š˜ ํ• ์ผ์„ ์ž‘์„ฑํ•˜๊ธฐ
    • Bug๋Š” ๊ทธ๋•Œ ๊ทธ๋•Œ
  • Issue Template
    • ์ œ๋ชฉ
      • [FE] ๊ธฐ๋Šฅ์ด๋ฆ„-๊ฐœ๋ฐœํ•ด์•ผํ•˜๋Š”๊ฒƒ..
      • [BE] ๊ธฐ๋Šฅ์ด๋ฆ„-๊ฐœ๋ฐœํ•ด์•ผํ•˜๋Š”๊ฒƒ..
    • ๋‚ด์šฉ
      ## :bulb: ์ด์Šˆ ๋‚ด์šฉ
      - ํ•ด๋‹น ์ด์Šˆ์˜ ๋‚ด์šฉ๊ณผ ๊ธฐ๋Œ€๋˜๋Š” ๊ฒฐ๊ณผ๋ฅผ ์ ์–ด์ฃผ์„ธ์š”.
      
      ## :white_check_mark: ์ž‘์—… ๋‚ด์šฉ
      - [ ] Todo1
      - [ ] Todo2
      
      ## :rotating_light: ์ฃผ์˜ ์‚ฌํ•ญ
      - ์ž‘์—… ์‹œ ์ฃผ์˜ํ•  ์‚ฌํ•ญ์„ ์ ์–ด์ฃผ์„ธ์š”.
      

2. 2. Commit

  • ๊ฐ€๋Šฅํ•œ ํ•œ๊ธ€๋กœ ์ž‘์„ฑ
  • Commit Template
    # [TYPE]prefix: title-#01
    
    # ๋‚ด์šฉ 
    
    #-------------------------
    # type can be
    #   FE : Frontend
    #   BE : Backend
    #-------------------------
    # prefix can be
    #   add : ๊ธฐ๋Šฅ ์™„์„ฑ X  
    #   feat : ๊ธฐ๋Šฅ ์™„์„ฑ
    #   fix
    #   refactor
    #   chore
    #   docs
    #   test
    
    • ํ…œํ”Œ๋ฆฟ ์ ์šฉํ•˜๊ธฐ
    $ git config commit.template .ํ…œํ”Œ๋ฆฟํŒŒ์ผ.txt 
    

2. 3. Branch

  • Upstream
    • main
    • dev
    • release-FE
    • release-BE
  • Origin
    • feat/...

2. 4. PR

  • Pull Request Template
    • ์ œ๋ชฉ
      • [FE] ๋‚ด์šฉ..
      • [BE] ๋‚ด์šฉ..
    • ๋‚ด์šฉ
      ## :white_check_mark: ์ž‘์—… ๋‚ด์šฉ
      - Todo1
      - Todo2
      
      ## :hammer: ๋ณ€๊ฒฝ๋กœ์ง 
      - ๋‚ด์šฉ์„ ์ ์–ด์ฃผ์„ธ์š”. (๋ฆฌ๋ทฐ ํ•  ๋•Œ ์ค‘์š”ํ•œ ๋ถ€๋ถ„์„ ์ ์–ด๋‘๋„๋ก ํ•ฉ์‹œ๋‹ค.)
      
      ## :camera_flash: ์Šคํฌ๋ฆฐ์ƒท (Optional)
      
      ## :lock: ๊ด€๋ จ ์ด์Šˆ(๋‹ซ์„ ์ด์Šˆ)
      - close #issueNumber
      

2. 5. Review

  • Web
    • 1๋ช…์ด์ƒ ๋ฆฌ๋ทฐํ–ˆ์„ ๋•Œ Merge๊ฐ€ ๊ฐ€๋Šฅ
    • ๋ฆฌ๋ทฐ ์ดํ›„์— ์ˆ˜์ •ํ•œ ์ฝ”๋“œ๋ฅผ commitํ•˜์—ฌ ์Šค์Šค๋กœ Merge