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)