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
+