From 4429eed55bbcc3b909be58fc3ff68c0544354604 Mon Sep 17 00:00:00 2001 From: Son Chanhyeok <127181634+hyeokson@users.noreply.github.com> Date: Mon, 26 Aug 2024 09:50:19 +0900 Subject: [PATCH] Update README.md --- README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) diff --git a/README.md b/README.md index aefc0114..2e629f1f 100644 --- a/README.md +++ b/README.md @@ -87,8 +87,95 @@ ### ๋ฐฐํฌ ![image](https://github.com/user-attachments/assets/ae5c53bf-2507-43b6-971b-8dfb7d7effa0) +## ๐Ÿ™Œ ํŒ€ ๊ทœ์น™ + +
+ ์ปค๋ฐ‹ & ๋ธŒ๋žœ์น˜ + +# ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜ + +``` +// ์˜ˆ์‹œ + +label: subject + +- label์€ issue label๊ณผ ๋™์ผ +- subject์€ ํ•ด๋‹น ์ปค๋ฐ‹์— ๋Œ€ํ•œ ๋‚ด์šฉ์„ ์ž˜ ์ดํ•ดํ•  ์ˆ˜ ์žˆ๊ฒŒ ์š”์•ฝ ํ•  ๊ฒƒ +``` + +# ๋ธŒ๋žœ์น˜ ์ „๋žต + +```jsx + main + | + | + develop + | + |--------------------------| + | | +feat/issue_num feat/issue_num + +- feat - ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„ +- fix - ๋ณ€๊ฒฝ์‚ฌํ•ญ(๋ณ€์ˆ˜, css ๋“ฑ) +- refactor - ๊ตฌ์กฐ ๋ณ€๊ฒฝ ex) api ์ „ํ›„ ๋ฐ์ดํ„ฐ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ ๋ณ€๊ฒฝ? +- Test - ํ…Œ์ŠคํŠธ ์ฝ”๋“œ + +``` + +**master ๋ธŒ๋žœ์น˜** + +- ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ๋งŒ์„ ๊ด€๋ฆฌํ•˜๋Š” ๋ธŒ๋žœ์น˜ + +**develop ๋ธŒ๋žœ์น˜** + +- ๋‹ค์Œ์— ๋ฐฐํฌํ•  ๊ฒƒ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜ +- ๋ฐฐํฌ ํ›„, ๋ฌธ์ œ๊ฐ€ ์—†์œผ๋ฉด master ๋ธŒ๋žœ์น˜๋กœ PR + +**feature ๋ธŒ๋žœ์น˜** + +- ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•  ๋•Œ ์‚ฌ์šฉํ•˜๋Š” ๋ธŒ๋žœ์น˜ + +**๋ธŒ๋žœ์น˜ ์ „๋žต - [์•„๋ž˜ ์ฐธ๊ณ ]/issue number** + +- feat - ์ƒˆ ๊ธฐ๋Šฅ +- fix - ๋ณ€๊ฒฝ์‚ฌํ•ญ(๋ณ€์ˆ˜, css ๋“ฑ) +- refactor - ๊ตฌ์กฐ ๋ณ€๊ฒฝ ex) api ์ „ํ›„ ๋ฐ์ดํ„ฐ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ ๋ณ€๊ฒฝ? +- test - ํ…Œ์ŠคํŠธ ์ฝ”๋“œ +- chore - ํ™˜๊ฒฝ ์„ค์ •, ์ฃผ์„ ์ œ๊ฑฐ, ์ด๋ฏธ์ง€ ํŒŒ์ผ ์ถ”๊ฐ€ ๋“ฑ + +
+ +
+ ๊ทธ๋ผ์šด๋“œ ๋ฃฐ + +## ํšŒ์˜ + +- ๋งค์ผ ์•„์นจ์— **`30๋ถ„`** ์Šคํฌ๋Ÿผ + - ๊ฐœ๋ฐœ ์ƒํ™ฉ, ์˜ค๋ฅ˜, ์˜ค๋Š˜ ํ•  ์ผ +- ๋งค์ผ ์˜คํ›„ 6์‹œ์— ๊ฐ€๋Šฅํ•˜๋ฉด PR ํ•˜๊ธฐ +- ํšŒ๊ณ  ์ž‘์„ฑ + - ๋งค์ผ ์˜คํ›„ **`6์‹œ 30๋ถ„`** + - ์•Œ๊ฒŒ๋œ ์ , ์ข‹์•˜๋˜ ์ , ๋ณด์™„ํ•  ์  + +## ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜ + +- ๋งค์ผ ๊ฐ™์ด ๋ฐฅ๋จน๊ธฐ + - ๋ฐฅ ๋จน์„ ๋•Œ ์ผ ์–˜๊ธฐ ํ•˜์ง€ ์•Š๊ธฐ +- ํšŒ์˜ ์ค‘์— ์„œ๋กœ ํฐ์†Œ๋ฆฌ ๋‚ด์ง€ ์•Š๊ธฐ +- ๋ฐ˜๋ฐ• ์˜๊ฒฌ ๋‚ด๊ธฐ ์ „์— ์ข‹์€ ์˜๊ฒฌ์ด๋ผ๊ณ  ๋จผ์ € ์นญ์ฐฌํ•˜๊ธฐ +- ๋น„๋‚œํ•˜์ง€ ๋ง๊ธฐ +- ๋งˆ์Œ์— ์•ˆ๋“œ๋Š”๊ฒŒ ์žˆ์–ด๋„ ์ข‹์€ ๋ง์„ ๋จผ์ €ํ•˜๊ณ  ๊ทธ ๋‹ค์Œ์— ๋งˆ์Œ์— ์•ˆ๋“œ๋Š” ๊ฒƒ์„ ๋งํ•˜๊ธฐ +- ๋ฆฌ์•ก์…˜ ์ž˜ํ•ด์ฃผ๊ธฐ +- ๋ฐ˜๋งํ•˜๊ธฐ +- ์„œ๋กœ ์ธ์‚ฌ ์ž˜ ํ•˜๊ธฐ +- ๋™์˜ํ•  ๋•Œ โ€œ๊ทธ๋ž˜โ€๊ฐ€ ์•„๋‹ˆ๋ผ โ€œ์ข‹์•„โ€๋ผ๊ณ  ๋งํ•˜๊ธฐ +- ์ฃผ๋ง์— ๊ธ‰ํ•œ ์‚ฌํ•ญ์ด ์•„๋‹ˆ๋ฉด Discord๋กœ ์—ฐ๋ฝํ•˜์ง€ ๋ง๊ธฐ(์ตœ๋Œ€ํ•œ ํ‰์ผ์— ~^^) +- ์ง€๊ฐ, ์กฐํ‡ด ์‹œ ๋ฏธ๋ฆฌ ์•Œ๋ ค์ฃผ๊ธฐ +
+
ํšŒ๊ณ  https://www.notion.so/bside/3f4a3606067143fbb54bd5e584afe762
+