Code Convention - pie-sfac/1-16-careMango GitHub Wiki
Code Convention
- ๋ณ์ ์ ์ธ ์ ์ฌํ ๋น๋์ง ์๋ ๊ฐ์
const, ๊ทธ ๋ฐ๋์ ๊ฒฝ์ฐ let์ ์ฌ์ฉํฉ๋๋ค.
- ๊ตฌ์กฐ๋ถํดํ ๋น์ ์ ๊ทน์ ์ผ๋ก ์ฌ์ฉํฉ๋๋ค.
- ์ฃผ์์ ์ค๋ช
ํ๊ณ ์ ํ๋ ๋์์ ์์ ์ฐ๋, ๊ฐ๋ตํ๊ฒ ์์ฑํฉ๋๋ค.
- img ํ๊ทธ์ alt๋ฅผ ๊ผญ ๋ฃ๊ณ , ํ๊ธ๋ก ๋ฃ์ด์ค๋๋ค.
- ๋ณํฉ ์ ์ฃผ์์ ์ ๊ฑฐํฉ๋๋ค.
- ์ต๋ํ ์ฝ์ด ์ฌ์ฉ์ ์ง์ํฉ๋๋ค.
Naming
- Component ํ์ผ๋ช
์ PascalCase๋ฅผ ์ฌ์ฉํฉ๋๋ค. (ex.
Header.jsx, CookieBanner.jsx)
- Non-Component ํ์ผ๋ช
์ camelCase๋ฅผ ์ฌ์ฉํฉ๋๋ค. (ex.
cookieHelper.js, fetchApi.js)
- ์์ฑ๋ช
์ camelCase๋ฅผ ์ฌ์ฉํฉ๋๋ค. (ex.
className, onClick)
- ๋ณ์๋ช
์ camelCase๋ฅผ ์ฌ์ฉํฉ๋๋ค.
- ์ด๋ฆ์ ํตํด ์ฐ์์๋ฅผ ์ ์ ์๋๋ก ํฉ๋๋ค. (20์ ๋ฏธ๋ง, ์ง๊ด์ ์ด๊ฒ)
- ์ด๋ฆ์ ๋งจ ์์ด๋ ๋งจ ๋ค์ ์ธ๋๋ฐ(_)๋ฅผ ์ฌ์ฉํ์ง ์์ต๋๋ค.
- ํจ์ ์ด๋ฆ์ ๋์ฌ+๋ช
์ฌ ๊ตฌ์กฐ๋ก ๋ค์ด๋ฐํฉ๋๋ค.