Skip to content

Team Rules

demetoir edited this page Nov 17, 2019 · 13 revisions

Ground Rule

  • Done is better than perfect
  • ํœด๊ฐ€, ๋ฐ˜๊ฐ€ ์‚ฌ์šฉ์‹œ 1์ฃผ์ผ ์ „์—๋Š” ์Šฌ๋ž™์— ๊ณต์ง€ํ•ฉ๋‹ˆ๋‹ค.
  • ์ง€๊ฐ์‹œ 30๋ถ„ ์ „์—๋Š” ์•Œ๋ ค์ฃผ์„ธ์š”.
  • ์‹์‚ฌ์‹œ๊ฐ„ 11:30 ~ 12:50 ์ž…๋‹ˆ๋‹ค. ๊ฐ€๊ธ‰์  1์‹œ๋ถ€ํ„ฐ๋Š” ๋ฐ”๋กœ ์‹œ์ž‘ํ•  ์ˆ˜ ์žˆ๊ฒŒ ํ•ด์ฃผ์„ธ์š”.
  • 30๋ถ„ ~ 1์‹œ๊ฐ„๋™์•ˆ ๋™์ผํ•œ ๋ฌธ์ œ ํ•ด๊ฒฐํ•˜์ง€ ๋ชปํ• ๊ฒฝ์šฐ, ๋‹ค๋ฅธ ํŒ€์›๋“ค์—๊ฒŒ ๋ฐ”๋กœ ์•Œ๋ ค์ฃผ๊ณ , ๋ฌธ์ œ์˜ ์šฐ์„ ์ˆœ์œ„์— ๋”ฐ๋ผ ํŽ˜์–ดํ”„๋กœ๊ทธ๋ž˜๋ฐ์„ ํ• ์ง€ ๊ฒฐ์ • ํ•ฉ๋‹ˆ๋‹ค.
  • ์Šคํ”„๋ฆฐํŠธ์˜ ์ฒซ ๋‚ ์€ ํ•œ ์ฃผ์˜ ์ž‘์—… ํ’€์„ ์„ค์ •ํ•˜๊ณ , ํ•„์š”์— ๋”ฐ๋ผ ๊ธฐ๋ฐ˜ ์ฝ”๋“œ๋ฅผ ํŽ˜์–ดํ”„๋กœ๊ทธ๋ž˜๋ฐ์œผ๋กœ ์ž‘์„ฑํ›„ ๊ฐœ๋ณ„ ์ž‘์—…์„ ์ง„ํ–‰ํ•ฉ๋‹ˆ๋‹ค.
  • ๊ธฐํš ๋ฐ ๊ฐœ๋ฐœ ์‚ฐ์ถœ๋ฌผ์€ ๊ตฌ๊ธ€ ๋“œ๋ผ์ด๋ธŒ ๊ณต์œ  ํด๋”์— ์ €์žฅํ•ฉ๋‹ˆ๋‹ค.

Code review

  • ๋ชจ๋“  PR์€ ์ ์–ด๋„ ํ•œ๋ช…์˜ reviewer์— ์˜ํ•ด ๋ฆฌ๋ทฐ๋˜์–ด์ ธ์•ผํ•ฉ๋‹ˆ๋‹ค.
  • ํŽ˜์–ด ์ฝ”๋”ฉ ๋ฐ 2์ธ ์ด์ƒ์ด ์„ค๊ณ„ํ•œ๊ฒฝ์šฐ ์ด๋ฏธ ๋ฆฌ๋ทฐ๋œ๊ฒƒ์œผ๋กœ ๊ฐ„์ฃผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Coding Convention

  • js์˜ ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜์€ eslint-config-naver ์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.
  • CSS ๋ฐฉ์‹์€ styled component ๋กœ ํ•ฉ๋‹ˆ๋‹ค.
  • CSS ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌsms material-ui ๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

๊ฐœ๋ฐœ ํ™˜๊ฒฝ

  • ๊ฐœ๋ฐœ์— ์‚ฌ์šฉํ•  IDE๋Š” ์ž์œ ์ž…๋‹ˆ๋‹ค.
  • .vscode, .idea ๊ฐ™์€ idea ์„ค์ •ํŒŒ์ผ์€ ๊นƒ ์ปค๋ฐ‹์—์„œ ์ œ์™ธํ•ฉ๋‹ˆ๋‹ค.
  • ํŽ˜์–ด ์ฝ”๋”ฉ์‹œ vscode ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.

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

  • git ์‚ฌ์šฉํˆด์€ gitkraken์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
  • github flow๋ฅผ ๊ธฐ๋ณธ ์ „๋žต์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.
  • ๋ธŒ๋ Œ์น˜ ๋ณ‘ํ•ฉ์€ rebase ๋ฐฉ์‹์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.
  • ๋ธŒ๋ Œ์น˜ ๋ช…๋ช… ๊ทœ์น™์€ git flow์˜ ๊ทœ์น™์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.
  • PR์„ ํ•˜๊ธฐ์ „์— eslint๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ lint error๊ฐ€ ์—†๋Š”์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.

git Commit ๊ทœ์น™

  • ์ฒซ์ค„์€ ์ปค๋ฐ‹์˜ ๋ผ๋ฒจ, ์ œ๋ชฉ ์ด์Šˆ๋„˜๋ฒ„๋ฅผ ํ•„์ˆ˜๋กœ ์ ์Šต๋‹ˆ๋‹ค.

  • ๋‘๋ฒˆ์จฐ ์ค„์€ ๊ณต๋ฐฑ๋งŒ ๋‚จ๊น๋‹ˆ๋‹ค.

  • ์„ธ๋ฒˆ์จฐ ์ค„๋ถ€ํ„ฐ ์ปค๋ฐ‹์— ๊ด€ํ•œ ๋‚ด์šฉ์„ ์ ์Šต๋‹ˆ๋‹ค.

  • ์ปค๋ฐ‹ ๋‚ด์šฉ ํ˜•์‹์€ markdown ํ˜•์‹์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.

  • ์ปค๋ฐ‹๋œ ์ฝ”๋“œ๋Š” prettier๋กœ ์ •๋ฆฌ๋˜์–ด์•ผํ•ฉ๋‹ˆ๋‹ค.

  • git commit message์˜ ๋ผ๋ฒจ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.

    • feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
    • delete: ๊ธฐ๋Šฅ ์‚ญ์ œ
    • fix: ๋ฒ„๊ทธ ์ˆ˜์ •
    • docs: ๋ฌธ์„œ ์ˆ˜์ •
    • lint: ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ
    • refactor: ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง
    • test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
    • chore: ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •
    • typo: ์˜คํƒ€์ˆ˜์ •
    • enhance: ๊ฐ„๋‹จํ•œ ๊ฐœ์„ ์‚ฌํ•ญ์„ ๊ธฐ๋Šฅ์— ์ถ”๊ฐ€
  • ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ์˜ˆ์‹œ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.

    fix: ๋ชจ๋‹ฌ ๋‹ซํž˜ ๋ฒ„๊ทธ ์ˆ˜์ • #33
    
    # why
    ์™œ ์ด์ปค๋ฐ‹์ด ํ•„์š”ํ•œ์ง€
    
    # how
    ์–ด๋–ป๊ฒŒ ๊ตฌํ˜„ ๋˜๋Š” ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ–ˆ๋Š”์ง€
    
    # warning
    ์š”๊ตฌ์กฐ๊ฑด์€ ๋งŒ์กฑํ•˜์ง€๋งŒ ์ž ์žฌ์ ์œผ๋กœ ๋ฌธ์ œ๋ฅผ ์ผ์œผํ‚ฌ ์ˆ˜ ์žˆ๋Š” ์‚ฌํ•ญ
    

Clone this wiki locally