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

Ground Rule

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

์Šคํฌ๋Ÿผ

  • ์–ด์ œ ํ–ˆ๋˜ ์ผ,์ปจ๋””์…˜
  • ์–ด์ œ ํ–ˆ๋˜์ผ, ์˜ค๋Š˜ ํ•  ์ผ ์ •๋ฆฌ
  • ์œ„ํ‚ค์— ์ •๋ฆฌ
    • HackMD๋กœ ์ •๋ฆฌํ•˜๊ณ  ์œ„ํ‚ค์— upload

ํšŒ๊ณ 

  • ๋งค์ผ 6์‹œ 45๋ถ„์— ๋งŒ๋‚˜์„œ ํ•จ๊ป˜ ํšŒ๊ณ ๋ก ์ž‘์„ฑ

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

  • ์‹œ๊ฐ„ : ์›”,๋ชฉ
  • ์žฅ์†Œ : ์ŠคํŒŒํฌํ”Œ๋Ÿฌ์Šค ๊ฐ•๋‚จ4ํ˜ธ์  (์›”, ๋ชฉ ์ด์™ธ์— ๋ชจ์ผ์‹œ ์‚ฌ๋‹น์—ญ!)
  • ์˜จ๋ผ์ธ ํšŒ์˜๋Š” ์‹œ๊ฐ„์„ ๋ช…ํ™•ํžˆ ๋งํ•ด์ฃผ๊ณ  @here๋กœ ํŒ€์›๋“ค์„ ์†Œํ™˜ํ•˜๊ณ , ํ™•์ธํ•œ ํŒ€์›์€ Check ํ‘œ์‹œ ํ•ด์ฃผ๊ธฐ !

Git

Issue

  • Label : iOS, BE, FE, Common

  • Milestone : ๊ธฐ๋Šฅ๋ณ„ ๋ชฉํ‘œ

  • Kanban : iOS, Back, Front

  • ์ž‘์„ฑ๋ฐฉ๋ฒ•

    • ์Šคํฌ๋Ÿผ ๋๋‚˜๊ณ  ๋ณธ์ธ์˜ ์˜ค๋Š˜ ํ• ์ผ์„ ์ž‘์„ฑํ•˜๊ธฐ
    • Bug๋Š” ๊ทธ๋•Œ ๊ทธ๋•Œ
  • Issue Template

    • ์ œ๋ชฉ
      • [iOS] ๋‚ด์šฉ..
      • [FE] ๋‚ด์šฉ..
      • [BE] ๋‚ด์šฉ..
    • ๋‚ด์šฉ
      ## :bulb: ์ด์Šˆ ๋‚ด์šฉ
      - ํ•ด๋‹น ์ด์Šˆ์˜ ๋‚ด์šฉ๊ณผ ๊ธฐ๋Œ€๋˜๋Š” ๊ฒฐ๊ณผ๋ฅผ ์ ์–ด์ฃผ์„ธ์š”.
      
      ## :white_check_mark: ์ž‘์—… ๋‚ด์šฉ
      - [ ] Todo1
      - [ ] Todo2
      
      ## :rotating_light: ์ฃผ์˜ ์‚ฌํ•ญ
      - ์ž‘์—… ์‹œ ์ฃผ์˜ํ•  ์‚ฌํ•ญ์„ ์ ์–ด์ฃผ์„ธ์š”.
      

Commit

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

Branch

  • Upstream

    • master
    • dev
    • dev-iOS
    • dev-FE
    • dev-BE
  • Origin

    • feat/...

PR

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

๋ฆฌ๋ทฐ

  • Web

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

    • PR๋‹จ๊ณ„์—์„œ Reviewer๋กœ ์„ค์ •๋œ Reviewer์˜ ์Šน์ธ์ด ์žˆ๊ธฐ ์ „๊นŒ์ง€๋Š” Merge๋ฅผ ํ•  ์ˆ˜ ์—†์Œ!
    • ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ˜์˜ํ•œ commit ๋‚ ๋ฆฌ๊ณ  ๋‹ค์‹œํ•œ๋ฒˆ ๋ฆฌ๋ทฐ ํ™•์ธ
    • ๋ณธ์ธ PR ์Šค์Šค๋กœ Merge

Document

์Šคํฌ๋Ÿผ

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

ํšŒ๊ณ (๊ฐœ๋ฐœ์ผ์ง€, ๊ฐœ์ธํšŒ๊ณ , ...)

๋งค์ผ 6์‹œ 45๋ถ„!

iOS, Front, Back ๋””๋ ‰ํ„ฐ๋ฆฌ ์•ˆ์— README.md ํŒŒ์ผ์— ๋งค์ผ ์ •๋ฆฌ

  • ๊ฐœ๋ฐœ์ผ์ง€

    • ๊ทธ๋‚  ๊ฐœ๋ฐœํ•œ ๋‚ด์šฉ, ์–ด๋ ค์› ๋˜ ์ , ํ•ด๊ฒฐ ๊ณผ์ • ๊ธฐ๋ก
  • ๊ฐœ์ธํšŒ๊ณ 

    • ์˜ค๋Š˜ ํ•˜๋ฃจ๋ฅผ ์–ด๋–ป๊ฒŒ ๋ณด๋ƒˆ๋Š”์ง€ ์†Œ๊ฐ ๊ธฐ๋ก
    • ์ž˜ํ•œ ์ ์ด ์žˆ์œผ๋ฉด ์Šค์Šค๋กœ ์นญ์ฐฌํ•ด์ฃผ๊ณ , ๋ถ€์กฑํ•œ ์ ์€ ๊ฐœ์„ ์ ์„ ์ƒ๊ฐํ•ด๋ณด๊ธฐ