Development Rules - boostcamp-2020/Project15-A-Client-Based-Formula-Editor GitHub Wiki

๐Ÿ“Œ ๊ฐœ๋ฐœ ๊ทœ์น™

โœ”๏ธ Git ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ์Šคํƒ€์ผ ๊ฐ€์ด๋“œ

  • feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
  • fix : ๋ฒ„๊ทธ ์ˆ˜์ •
  • docs : ๋ฌธ์„œ์˜ ์ˆ˜์ •
  • style : (์ฝ”๋“œ์˜ ์ˆ˜์ • ์—†์ด) ์Šคํƒ€์ผ(style)๋งŒ ๋ณ€๊ฒฝ(๋“ค์—ฌ์“ฐ๊ธฐ ๊ฐ™์€ ํฌ๋งท์ด๋‚˜ ์„ธ๋ฏธ์ฝœ๋ก ์„ ๋นผ๋จน์€ ๊ฒฝ์šฐ)
  • refactor : ์ฝ”๋“œ๋ฅผ ๋ฆฌํŽ™ํ† ๋ง
  • test : Test ๊ด€๋ จํ•œ ์ฝ”๋“œ์˜ ์ถ”๊ฐ€, ์ˆ˜์ •
  • chore : (์ฝ”๋“œ์˜ ์ˆ˜์ • ์—†์ด) ์„ค์ •์„ ๋ณ€๊ฒฝ
  • modify : ์ฝ”๋“œ ๋ณ€๊ฒฝ
  • build : ์ƒˆ๋กœ์šด ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ํ˜น์€ ํŒจํ‚ค์ง€ ์„ค์น˜
ex) feat: ์ œ๋ชฉ 

- ์ƒ์„ธ ๋‚ด์šฉ1
- ์ƒ์„ธ ๋‚ด์šฉ2

โœ”๏ธ Coding Convention

  • ํ•จ์ˆ˜๋Š” ํ™”์‚ดํ‘œ ํ•จ์ˆ˜ ๋ฐฉ์‹์œผ๋กœ ์ž‘์„ฑํ•œ๋‹ค.
  • var๋ฅผ ์“ฐ์ง€ ์•Š๊ณ , const์™€ let์œผ๋กœ ๊ตฌ์„ฑํ•œ๋‹ค.(๋‹จ, const๋ฅผ ์ฃผ๋กœ ์“ฐ๋˜ ๋ณ€์ˆ˜์˜ ๊ฐ’ ๋ณ€๊ฒฝ์ด ํ•„์š”ํ•  ๊ฒฝ์šฐ let์„ ์“ด๋‹ค.) -- eslint
  • image, svg๋Š” -๋กœ ์ž‘์„ฑํ•œ๋‹ค.(ex. erase-check.svg)
  • ๋ณ€์ˆ˜๋ช…์€ camelCase๋กœ ์ž‘์„ฑํ•œ๋‹ค. (issueLabel)
  • .jsx๋ฅผ ์ œ์™ธํ•œ ํŒŒ์ผ๋ช… ์ค‘ ๋‹จ์–ด๊ฐ€ ํ•œ ๊ฐœ์ผ ๊ฒฝ์šฐ๋Š” ์†Œ๋ฌธ์ž๋กœ ์ž‘์„ฑํ•œ๋‹ค. ex) category.js
  • .jsx ํŒŒ์ผ์˜ ํŒŒ์ผ๋ช…์€ PascalCase๋ฅผ ์‚ฌ์šฉํ•œ๋‹ค. ex) LoginPage.jsx
  • webpack alias๋ฅผ ์ด์šฉํ•ด์„œ ํŒŒ์ผ ์ ˆ๋Œ€ ๊ฒฝ๋กœ๋กœ import, export ์‚ฌ์šฉ
  • ๋งŒ์•ฝ ์ฃผ์„์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ // TODO: ํ•ด์•ผ ํ•  ์ผ ํ˜น์€ ํ•œ ์ผ์„ ์ ์–ด์ค€๋‹ค(2020.10.30)
  • css๋Š” styled-components๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ
  • for๋ฌธ ์‚ฌ์šฉํ•˜์ง€ ์•Š๊ธฐ(ex. for(let i=0; i<10; i++))
  • ์ด๋ฒคํŠธ ํ•ธ๋“ค๋Ÿฌ๋Š” on + ๋ฉ”์†Œ๋“œ๋ช… + handler๋กœ ์ •์˜ํ•œ๋‹ค.(ex. onClickHandler)