Skip to content

Latest commit

ย 

History

History
43 lines (31 loc) ยท 1.05 KB

convention.md

File metadata and controls

43 lines (31 loc) ยท 1.05 KB

๊ทœ์น™ ๋ฐ ์ปจ๋ฒค์…˜


๋ฏธํŒ… ์‹œ๊ฐ„

  1. ์ฝ”์–ดํƒ€์ž„์€ 1-5์‹œ
  2. ๋ฐ์ผ๋ฆฌ ์Šคํฌ๋Ÿผ์€ 1์‹œ ์‹œ์ž‘ํ•  ๋•Œ ๊ฐ„๋‹จํ•˜๊ฒŒ

์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

  • [feat] ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ์ปค๋ฐ‹
  • [fix] ๋ฒ„๊ทธ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
  • [docs] ๋ฌธ์„œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
  • [build] ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
  • [chore] ๊ทธ ์™ธ ์ž์ž˜ํ•œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
  • [style] ์ฝ”๋“œ ์Šคํƒ€์ผ ํ˜น์€ ํฌ๋งท ๋“ฑ์— ๊ด€ํ•œ ์ปค๋ฐ‹
  • [refactor] ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง์— ๋Œ€ํ•œ ์ปค๋ฐ‹
  • [test] ํ…Œ์ŠคํŠธ ์ฝ”๋“œ์— ๋Œ€ํ•œ ์ปค๋ฐ‹

๋ธŒ๋žœ์น˜ ์ปจ๋ฒค์…˜

  • ๋ธŒ๋žœ์น˜ ์ด๋ฆ„
    • ํ”„๋ก ํŠธ๋Š” F/๊ธฐ๋Šฅ๋ช…, ๋ฐฑ์€ B/๊ธฐ๋Šฅ๋ช…
  • ๋ธŒ๋žœ์น˜ ๊ด€๋ฆฌ
    1. develop์—์„œ feature ๋ธŒ๋žœ์น˜๋ฅผ ๋”ฐ๊ณ 
    2. ์˜ค๋ฅ˜๊ฐ€ ๋ชจ๋‘ ์ œ๊ฑฐ๋œ ์™„์ „ํ•œ dev๋ฅผ master์— merge
    3. develop ๋ธŒ๋žœ์น˜๋ฅผ ๋”ฐ์„œ 1๋ถ€ํ„ฐ ๋ฐ˜๋ณต
  • ๋ ˆํฌ๋Š” ํ•˜๋‚˜์—์„œ ํด๋”๋งŒ client/server๋กœ ๋‚˜๋ˆ ์„œ ๊ตฌ์„ฑ

์ฝ”๋“œ ์ปจ๋ฒค์…˜

  • ๋ณ€์ˆ˜, ํ•จ์ˆ˜ : camelCase
  • ์ปดํฌ๋„ŒํŠธ, ํŒŒ์ผ : PascalCase
  • ์ƒ์ˆ˜ : UPPERCASE_SNAKE_CASE
  • ํด๋” : kebab-case
  • ํด๋ž˜์Šค, ์ธํ„ฐํŽ˜์ด์Šค : PascalCase