Ground Rule - boostcampwm-2022/web36-Japari GitHub Wiki

ํ™œ๋™ ์‹œ๊ฐ„

  • ์ฝ”์–ด ํƒ€์ž„์€ ์ ์‹ฌ์‹œ๊ฐ„, ๋งˆ์Šคํ„ฐ ํด๋ž˜์Šค๋ฅผ ์ œ์™ธํ•œ 10:00 ~ 19:00
  • ์ฝ”์–ด ํƒ€์ž„ ์ด์™ธ์— ์ž‘์—…์€ ํŒ€์›์—๊ฒŒ ๋งํ•˜๊ณ  ํ•˜๊ธฐ, ์•ผ๊ทผ, ์ฃผ๋ง ๋“ฑ.. ๊ผญ ๋งํ•˜์„ธ์š”
  • ์ฝ”์–ด ํƒ€์ž„ ๊ฐ„ ๊ฒŒ๋”ํƒ€์šด ์ ‘์†
    • ์บ ์€ ํ‰์ƒ ์‹œ์— ์ผœ๋‘๊ณ , ๋งˆ์ดํฌ๋Š” ํ•„์š”ํ•  ๋•Œ๋งŒ
  • ๊ธฐ๋ณธ ์Šค์ผ€์ค„์€ ๋ถ€์ŠคํŠธ์บ ํ”„ ๋…ธ์…˜์— ์ฃผ๊ฐ„์ผ์ •ํ‘œ๋ฅผ ๋”ฐ๋ฅด๊ธฐ
    • 50๋ถ„~1์‹œ๊ฐ„ ํšŒ์˜/์ž‘์—… ์‹œ 10๋ถ„ ํœด์‹
    • ์ง€๊ฐํ•˜์ง€ ์•Š๊ธฐ โ†’ ๊ฐ€๊ธ‰์  ์‚ฌ์œ ๋ฅผ ๋ฏธ๋ฆฌ ๋งํ•˜๊ธฐ
    • ์ง€๊ฐํ•˜๊ฒŒ ๋˜๋ฉด ์Šค์ฟผํŠธ 10๊ฐœ

์Šค์ผ€์ค„ ๊ณต์œ 

  • ํŠน๋ณ„ํ•œ issue ์žˆ์œผ๋ฉด ์Šฌ๋ž™์œผ๋กœ ํŒ€์›์—๊ฒŒ ์•Œ๋ ค์ฃผ๊ธฐ
  • ํ™œ๋™ ์‹œ๊ฐ„๊ณผ ๊ฒน์น˜๋Š” ๊ฐœ์ธ ์Šค์ผ€์ค„ ๊ธฐ๋กํ•˜๊ธฐ!

ํŒ€ ๋ถ„์œ„๊ธฐ

  • ๋ฌด๋ฆฌํ•˜์ง€ ์•Š๊ธฐ (๋ฌด๋ฆฌํ•˜๊ธฐ)
  • ์˜๊ฒฌ์ด ๋งž์ง€ ์•Š์„ ๊ฒฝ์šฐ
    • ๋ฐ”๋กœ ๋งํ•˜๋ฉฐ ์˜๋…ผํ•˜๊ธฐ
    • ์„œ๋กœ ๋ฐฐ๋ คํ•˜๋ฉฐ ์†Œํ†ตํ•˜๊ธฐ

์•„์นจ ์Šคํฌ๋Ÿผ

  • ์˜ค๋Š˜ ํ•  ์ผ ์ •ํ•˜๊ธฐ
  • ์˜ค๋Š˜์˜ ํ•œ ๋งˆ๋””
  • ๋ถ„์—… ๋˜๋Š” ํŒ€์„ ๋‚˜๋ˆ ์„œ ๊ฐœ๋ฐœ์„ ํ–ˆ์„ ์‹œ ํŒ€์›๋“ค์—๊ฒŒ ์ž์‹ ์ด ๊ฐœ๋ฐœํ•œ ๊ธฐ๋Šฅ์„ ์„ค๋ช…

Github ์‚ฌ์šฉ ๊ทœ์น™

๋ธŒ๋žœ์น˜ ์ „๋žต

  • Git-flow (without release)
  • main, develop, feature, hotfix

image

Commit

  • ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์ด ๋๋‚  ๋•Œ๋งˆ๋‹ค commit
  • Commit ๋ฉ”์‹œ์ง€๋Š” git cz๋ฅผ ์‚ฌ์šฉํ•ด ์ž‘์„ฑ
  • ๋ฉ”์‹œ์ง€ ์ œ๋ชฉ: ์ž‘์—… ๋‚ด์šฉ์„ ์š”์•ฝํ•ด ํ•œ๊ธ€๋กœ ์ž‘์„ฑ
  • ๋ฉ”์‹œ์ง€ ๋ณธ๋ฌธ: ์„ธ๋ถ€ ๋‚ด์šฉ์€ ๋”ฐ๋กœ ์ž‘์„ฑํ•˜์ง€ ์•Š๊ณ  ๋ฏธ๋ฆฌ ์ž‘์„ฑํ•œ issue๋ฅผ ์—ฐ๊ฒฐ

Pull Request

  • ์ž‘์—… ๋‹น์ผ 20์‹œ๊นŒ์ง€ PR ์˜ฌ๋ฆฌ๊ธฐ

  • ๋‹ค์Œ๋‚  ์˜ค์ „ ์Šคํฌ๋Ÿผ ์ „๊นŒ์ง€ ๋‹ค๋ฅธ ์‚ฌ๋žŒ์˜ PR์— ์ฝ”๋ฉ˜ํŠธ ํ•˜๋‚˜์”ฉ ๋‹ฌ๊ธฐ

  • ๋งค์ผ ์˜ค์ „ ์Šคํฌ๋Ÿผ ์‹œ๊ฐ„์— ์ „๋‚  PR์˜ rebase merge ์—ฌ๋ถ€ ๊ฒฐ์ •

  • PR ๋ฉ”์‹œ์ง€๋Š” ํ…œํ”Œ๋ฆฟ์œผ๋กœ ๊ด€๋ฆฌ

    ---
    name: PR template
    about: PR template
    title: ''
    labels: ''
    assignees: c99-coder, seungjae94, kimhyeongjun95, tnghd5761
      
    ---
        
    ## ์ž‘์—… ๋‚ด์šฉ
    - 
        
    ## ์ „๋‹ฌ ์‚ฌํ•ญ
    - 
        
    ## ์ฐธ๊ณ  ์‚ฌํ•ญ
    - 
    

Issue

  • Project ํƒญ์—์„œ ๊ด€๋ฆฌ

  • ์ž‘์—…์„ ์‹œ์ž‘ํ•˜๊ธฐ ์ „์— issue๋ถ€ํ„ฐ ์ž‘์„ฑ

  • ์ž‘์—…์„ ๋๋‚ผ ๋•Œ commit๊ณผ ์—ฐ๊ฒฐ

  • Issue ๋ฉ”์‹œ์ง€๋Š” ํ…œํ”Œ๋ฆฟ์œผ๋กœ ๊ด€๋ฆฌ

    ---
    name: issue template
    about: feature template
    title: ''
    labels: ''
    assignees: c99-coder, seungjae94, kimhyeongjun95, tnghd5761
      
    ---
        
    ## ๋ชฉ์ 
        
    >
        
    ## ์ž‘์—… ๋‚ด์šฉ
        
    - [ ]
        
    ## ์ฐธ๊ณ  ์‚ฌํ•ญ
    - 
    

Wiki

  • ๊ฐœ๋ฐœ ๊ณผ์ • ๊ธฐ๋ก

ํŒ€ ํšŒ๊ณ 

  1. ํ•œ ์ฃผ ์š”์•ฝ + ์ž˜ํ•œ ์  + ๋ถ€์กฑํ–ˆ๋˜ ์  ๊ณต์œ 
  2. 1์‹œ๊ฐ„ ๋‚ด๋กœ ๋๋‚ด๊ธฐ ๋ชจ๋“  ๋ฉค๋ฒ„๊ฐ€ ์ฐธ์—ฌํ•˜๋„๋ก ๋…๋ ค
  3. ํ”ผ์–ด ํšŒ๊ณ ์˜ ๊ฐœ์„ ์  ๊ฐ™์ด ๊ณ ๋ฏผํ•˜๊ธฐ
  4. ๊ทธ๋ผ์šด๋“œ ๋ฃฐ, ์ฝ”๋“œ ๋ฆฌ๋ทฐ ๋ฐฉ์‹ ์ง€์†์ ์ธ ๊ฐœ์„ 

์‚ฌ์šฉ์ž ๋ถ„์„

  • ๋ˆ„๊ตฌ๋ฅผ ํƒ€๊นƒ์œผ๋กœ ํ•˜๋Š”๊ฐ€?
    • ๊ฐ™์ด ๊ฒŒ์ž„์„ ํ•˜๋ฉด์„œ ์–ด์ƒ‰ํ•œ ๋ถ„์œ„๊ธฐ๋ฅผ ํ’€์–ด๋ณด๊ณ  ์‹ถ์€ ํ˜„๋Œ€์ธ๋“ค
    • ์ž ๊น ์‹œ๊ฐ„์„ ๋‚ด์„œ ์–ผ๊ตด์„ ๋ณด๋ฉฐ ๊ฐ™์ด ๊ฒŒ์ž„์„ ํ•˜๊ณ  ์‹ถ์€ ํ˜„๋Œ€์ธ๋“ค
  • ํƒ€๊นƒ์€ ์–ด๋–ค ํŠน์ง•์ด ์žˆ๋Š”๊ฐ€?
    • ๊ฒŒ์ž„์„ ๊ฐ€๋ณ๊ฒŒ ์ฆ๊ธฐ๊ณ  ์‹ถ์–ด ํ•œ๋‹ค
    • ์ƒ๋Œ€๋ฐฉ๊ณผ ์†Œํ†ตํ•˜๋ฉฐ ๊ฒŒ์ž„ํ•˜๊ณ  ์‹ถ์–ดํ•  ๊ฒƒ ๊ฐ™๋‹ค
  • ํƒ€๊นƒ์€ ์–ด๋–ค ๋ฌธ์ œ๋ฅผ ๊ฐ–๊ณ  ์žˆ๋Š”๊ฐ€?
    • ๊ธฐ์กด ์˜จ๋ผ์ธ ๊ฒŒ์ž„์—์„œ ์„œ๋กœ์˜ ๋ฐ˜์‘์„ ๋ณด์ง€ ๋ชปํ•˜๋Š” ์•„์‰ฌ์›€์„ ๊ฐ€์ง€๊ณ  ์žˆ๋‹ค.
    • ๋ชฉ์†Œ๋ฆฌ, ์–ผ๊ตด์„ ๋ณด๋ ค๋ฉด ๋”ฐ๋กœ ํ”„๋กœ๊ทธ๋žจ์„ ์‚ฌ์šฉํ•ด์•ผ ๋˜๋Š” ๋ถˆํŽธํ•จ์„ ๊ฐ€์ง€๊ณ  ์žˆ๋‹ค.
  • ํƒ€๊นƒ์€ ์–ด๋–ค ์ƒํ™ฉ ๋˜๋Š” ํ™˜๊ฒฝ์—์„œ ์‚ฌ์šฉํ•˜๊ฒŒ ๋˜๋Š”๊ฐ€?
    • ํŽธํ•œ ๋ชจ์Šต์œผ๋กœ ์ง‘์—์„œ ์นœ๊ตฌ๋“ค๊ณผ ๋ชจ์—ฌ ๊ฒŒ์ž„ํ•˜๋Š” ์ƒํ™ฉ ๋˜๋Š” ํ™˜๊ฒฝ