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์ž ๋ฏธ๋งŒ, ์ง๊ด€์ ์ด๊ฒŒ)
  • ์ด๋ฆ„์˜ ๋งจ ์•ž์ด๋‚˜ ๋งจ ๋’ค์— ์–ธ๋”๋ฐ”(_)๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
  • ํ•จ์ˆ˜ ์ด๋ฆ„์€ ๋™์‚ฌ+๋ช…์‚ฌ ๊ตฌ์กฐ๋กœ ๋„ค์ด๋ฐํ•ฉ๋‹ˆ๋‹ค.