diff --git a/convention.md b/convention.md new file mode 100644 index 0000000000..5ca01eacd1 --- /dev/null +++ b/convention.md @@ -0,0 +1,100 @@ +
+๐Ÿ“ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜ +
+ +## 1๏ธโƒฃ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜ + +์ปค๋ฐ‹์„ ๋ณด๋‚ผ ๋•Œ ์ง€์ผœ์•ผํ•  ์–‘์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. +์ปค๋ฐ‹์€ ์ œ๋ชฉ + ๋‚ด์šฉ + (์ด์Šˆ ๋ฒˆํ˜ธ)๋กœ ์ด๋ฃจ์–ด์ ธ ์žˆ์Šต๋‹ˆ๋‹ค. + +
+
+ +## 2๏ธโƒฃ ์ œ๋ชฉ + +์ œ๋ชฉ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ๋ฐฉ์‹์œผ๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. +```type: title``` + +type์—๋Š” ์ปค๋ฐ‹์˜ ์ข…๋ฅ˜์— ๋”ฐ๋ผ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ๋‚˜๋‰˜์–ด ์ง‘๋‹ˆ๋‹ค. + + +Type | ๋‚ด์šฉ ์„ค๋ช… | ํ‘œ๊ธฐ๋ฒ• +-- | -- | -- +:sparkles: feat | ๊ธฐ๋Šฅ ์ถ”๊ฐ€/์ˆ˜์ • ๋“ฑ | ```:sparkles:``` +:bug: fix | ๋ฒ„๊ทธ ์ˆ˜์ • | ```:bug:``` +:memo: docs | ๋ฌธ์„œ ์ˆ˜์ • | ```:memo:``` +:bulb: comment | ์ฃผ์„ ๊ด€๋ จ ์ถ”๊ฐ€ ๋ฐ ์ˆ˜์ • | ```:bulb:``` +:pencil2: typo | ๊ฐ„๋‹จํ•œ ์˜คํƒ€ ์ˆ˜์ • (์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋˜๋Š” ํด๋ž˜์Šค ์ด๋ฆ„ ์˜คํƒ€ ๋“ฑ) | ```:pencil2:``` +:recycle: refactor | ๋ฆฌํŒฉํ† ๋ง | ```:recycle:``` +:lipstick: assets | UI ๊ด€๋ จ assets๋ฅผ ์—…๋กœ๋“œ, ์ˆ˜์ •, ์‚ญ์ œ | ```:lipstick:``` +:heavy_plus_sign: dependency | ์˜์กด์„ฑ ๊ด€๋ จ | ```:heavy_plus_sign:``` +:truck: rename | ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ | ```:truck:``` + + + +> :sparkles: feat: User ์—”ํ‹ฐํ‹ฐ ์ˆ˜์ • + +
+
+ +## 3๏ธโƒฃ ๋‚ด์šฉ + +๋‚ด์šฉ์—๋Š” ์„ธ๋ถ€์ ์ธ ๋ณ€๊ฒฝ ๋‚ด์šฉ์„ ์ค„๋งˆ๋‹ค -๋กœ ์‹œ์ž‘ํ•˜๋Š” ํ˜•ํƒœ๋กœ ์ ์Šต๋‹ˆ๋‹ค. + +``` +- User ์—”ํ‹ฐํ‹ฐ์— email, location, phone ํ•„๋“œ ์ถ”๊ฐ€ +- User ์—”ํ‹ฐํ‹ฐ์— Getter, Setter ๋ฒ”์œ„ ์„ค์ • +``` + +๋‚ด์šฉ์€ ํ•œ ์ค„ ๋‹น 72์ž ๋‚ด๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. +
+๋‚ด์šฉ์€ ์–‘์— ๊ตฌ์• ๋ฐ›์ง€ ์•Š๊ณ  ์ตœ๋Œ€ํ•œ ์ƒ์„ธํžˆ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. +
+๋‚ด์šฉ์€ ์–ด๋–ป๊ฒŒ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€ ๋ณด๋‹ค ๋ฌด์—‡์„ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€ ๋˜๋Š” ์™œ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. + +

+ + +## 4๏ธโƒฃ ์ด์Šˆ ๋ฒˆํ˜ธ + +์ด์Šˆ ๋ฒˆํ˜ธ์—๋Š” ๋งŒ์•ฝ ํ•ด๋‹น ์ปค๋ฐ‹์ด ํŠน์ • ์ด์Šˆ๊ณผ ๊ด€๋ จ๋œ ๊ฒฝ์šฐ "์œ ํ˜•: #์ด์Šˆ ๋ฒˆํ˜ธ"์˜ ํ˜•ํƒœ๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. +
+๊ด€๋ จ๋œ ์ด์Šˆ๊ฐ€ ์—†๋‹ค๋ฉด ์ƒ๋žต์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. +
+์—ฌ๋Ÿฌ ๊ฐœ์˜ ์ด์Šˆ ๋ฒˆํ˜ธ๋ฅผ ์ ์„ ๋•Œ๋Š” ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„ํ•ฉ๋‹ˆ๋‹ค. +
+ +์œ ํ˜• | ์ด์Šˆ๋ฒˆํ˜ธ +-- | -- +Fixes | ์ด์Šˆ ๊ด€๋ จ ๋‚ด์šฉ ์ˆ˜์ •์ค‘ (์•„์ง ํ•ด๊ฒฐ๋˜์ง€ ์•Š์€ ๊ฒฝ์šฐ) +Resolves | ์ด์Šˆ ๊ด€๋ จ ๋‚ด์šฉ ์ˆ˜์ • ์™„๋ฃŒ +Ref | ์ฐธ๊ณ ํ•  ์ด์Šˆ๊ฐ€ ์žˆ์„ ๋•Œ ์‚ฌ์šฉ +Related to | ํ•ด๋‹น ์ปค๋ฐ‹์— ๊ด€๋ จ๋œ ์ด์Šˆ๋ฒˆํ˜ธ (์•„์ง ํ•ด๊ฒฐ๋˜์ง€ ์•Š์€ ๊ฒฝ์šฐ) + +> Resolves: #123 +> Ref: #456 +> Related to: #48, #45 + +
+
+ + +## ์ „์ฒด ์˜ˆ์‹œ + +``` +:sparkles: feat: ์ถ”๊ฐ€ ๋กœ๊ทธ์ธ ํ•จ์ˆ˜ + +- ๋กœ๊ทธ์ธ API ๊ฐœ๋ฐœ + +Resolves: #123 +Ref: #456 +``` + +
+
+ + +
+
+ + \ No newline at end of file