diff --git a/README.md b/README.md index b7ed850..140f2cc 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,63 @@ -## ๐ŸŒฟ Branch ์ „๋žต & ๋„ค์ด๋ฐ ๊ทœ์น™ +## ๊ฐœ์š” -### ๐Ÿ”น Branch ์ข…๋ฅ˜ +### Bravest๋ž€ ๋ฌด์—‡์ธ๊ฐ€ -| Branch | ์—ญํ•  | ์„ค๋ช… | -|--------|------|------| -| **main** | ๋ฐฐํฌ์šฉ ๋ธŒ๋žœ์น˜ | ์‹ค์ œ ์„œ๋น„์Šค์— ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์•ˆ์ • ๋ฒ„์ „๋งŒ ์กด์žฌํ•ฉ๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ์ž๋Š” ์ง์ ‘ ์ž‘์—…ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. | -| **develop** | ๊ฐœ๋ฐœ ํ†ตํ•ฉ ๋ธŒ๋žœ์น˜ | ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜๋“ค์„ ๋ณ‘ํ•ฉํ•˜๋Š” ๋ธŒ๋žœ์น˜์ž…๋‹ˆ๋‹ค. ํ…Œ์ŠคํŠธ ์™„๋ฃŒ ํ›„ `main`๋กœ ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค. | -| **feature** | ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜ | ์ƒˆ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ์‹œ `develop`์—์„œ ๋ถ„๊ธฐํ•˜์—ฌ ์ž‘์—… ํ›„ `develop`์— ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค. | -| **release** | ๋ฐฐํฌ ์ค€๋น„ ๋ธŒ๋žœ์น˜ | ๋ฐฐํฌ ์ „ ํ…Œ์ŠคํŠธ, ๋ฌธ์„œ, ๋ฒ„๊ทธ ์ˆ˜์ • ๋“ฑ์„ ์ง„ํ–‰ํ•˜๋ฉฐ ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€๋Š” ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. | -| **hotfix** | ๊ธด๊ธ‰ ์ˆ˜์ • ๋ธŒ๋žœ์น˜ | ๋ฐฐํฌ ํ›„ ๋ฐœ์ƒํ•œ ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •ํ•  ๋•Œ `main`์—์„œ ๋ถ„๊ธฐ ํ›„ `main`, `develop`์— ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค. | +Bravest(์ดํ•˜ ๋ธŒ๋ ˆ์ด๋ธŒ์ŠคํŠธโ€™)์€ **์ต๋ช… ์ฑ— ์„œ๋น„์Šค**์ž…๋‹ˆ๋‹ค. + +ํ•ด๋‹น ์†Œํ”„ํŠธ์›จ์–ด๋Š” ๊ฒฝ๊ธฐ๋Œ€ํ•™๊ต 2025ํ•™๋…„๋„ 2ํ•™๊ธฐ '์˜คํ”ˆ์†Œ์ŠคSW์‹ค์Šตโ€™ ๊ณผ๋ชฉ์˜ ํ•™๊ธฐ ํ”„๋กœ์ ํŠธ๋ฅผ ์ˆ˜ํ–‰ํ•˜๊ธฐ ์œ„ํ•ด ์ œ์ž‘๋˜์—ˆ์Šต๋‹ˆ๋‹ค. ๋ฐฑ์—”๋“œ๋Š” Spring Boot ํ”„๋ ˆ์ž„์›Œํฌ๋ฅผ ์‚ฌ์šฉํ•˜์˜€์œผ๋ฉฐ, ๊ทธ ์™ธ ์˜์กด์„ฑ์€ `build.gradle`์„ ์ฐธ๊ณ ํ•˜์‹ญ์‹œ์˜ค. --- -### ๐Ÿงฉ ๋„ค์ด๋ฐ ๊ทœ์น™ +### ์„œ๋น„์Šค ํ•„์š”์„ฑ -| ์ข…๋ฅ˜ | ์˜ˆ์‹œ | ๊ทœ์น™ | -|------|------|------| -| **main / develop** | ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉ | ํŠน๋ณ„ํ•œ ์ ‘๋‘์‚ฌ ์—†์ด `main`, `develop` ์‚ฌ์šฉ | -| **feature** | `feature/1-login-api`, `feature/2-home-ui` | `feature/{issue-number}-{feature-name}` ํ˜•์‹ ์ถ”์ฒœ | -| **release** | `release-1.2`, `release-RB_1.7` | `release-๋ฒ„์ „๋ช…` ํ˜•์‹ ์‚ฌ์šฉ | -| **hotfix** | `hotfix-1.4.1` | ๊ธด๊ธ‰ ์ˆ˜์ •์šฉ ๋ธŒ๋žœ์น˜. `hotfix-๋ฒ„์ „๋ช…` ํ˜•์‹ ์‚ฌ์šฉ | +๋Œ€ํ•™์„ ํฌํ•จํ•œ ๋‹ค์–‘ํ•œ ํ˜‘์—… ํ™˜๊ฒฝ์—์„œ ํŒ€ ํ”„๋กœ์ ํŠธ๋Š” ํ•„์ˆ˜์ ์ด์ง€๋งŒ, ์‹ค์ œ ์„ฑ๊ณผ ๋„์ถœ ๊ณผ์ •์—์„œ๋Š” ๋ฐ˜๋ณต์ ์œผ๋กœ ๋™์ผํ•œ ๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ•œ๋‹ค. ๊ทธ์ค‘ ๊ฐ€์žฅ ํ•ต์‹ฌ์ ์ธ ์›์ธ์€ **์†Œํ†ต์˜ ๋ถ€์žฌ**์ด๋‹ค. ํŒ€์›์ด ์„œ๋กœ ๊นŠ์€ ๊ด€๊ณ„๊ฐ€ ์•„๋‹ˆ๊ฑฐ๋‚˜, ๊ณต์‹์ ์ธ ์‚ฐ์ถœ๋ฌผ์„ ๋งŒ๋“ค์–ด์•ผ ํ•œ๋‹ค๋Š” ๋ถ€๋‹ด๊ฐ์ด ์กด์žฌํ•˜๋ฉด ์˜๊ฒฌ ๊ฐœ์ง„์ด ์†Œ๊ทน์ ์œผ๋กœ ์ด๋ฃจ์–ด์ง€๊ณ , ์ด๋Š” ํ”„๋กœ์ ํŠธ ํ‘œ๋ฅ˜๋กœ ์ด์–ด์ง„๋‹ค. ---- +ํŠนํžˆ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ์š”์ธ์ด ๋ฌธ์ œ๋ฅผ ์‹ฌํ™”์‹œํ‚จ๋‹ค. + +- ์˜๊ฒฌ์ด ํšŒ์˜์˜ ๋ฐฉํ–ฅ์„ฑ๊ณผ ํŒ€์˜ ๋ชฉํ‘œ์— ์ง์ ‘์ ์ธ ์˜ํ–ฅ์„ ๋ฏธ์นœ๋‹ค๋Š” ๋ถ€๋‹ด๊ฐ +- ํ‘œํ˜„ํ•œ ์˜๊ฒฌ์ด ํ‰๊ฐ€ยท๋น„ํŒ์˜ ๋Œ€์ƒ์ด ๋œ๋‹ค๋Š” ์‹ฌ๋ฆฌ์  ์žฅ๋ฒฝ +- ํŒ€์›๋“ค์ด ๋‹ค์‹œ ๋งŒ๋‚  ๊ฐ€๋Šฅ์„ฑ์ด ๋‚ฎ๋‹ค๋Š” ํŠน์ˆ˜ํ•œ ํ˜‘์—… ํ™˜๊ฒฝ์—์„œ์˜ ์ฑ…์ž„ ํšŒํ”ผ ๊ฒฝํ–ฅ + +์ด๋Ÿฌํ•œ ์ƒํ™ฉ์€ ์ฐธ์—ฌ ์˜์ง€ ์ €ํ•˜, ์˜์‚ฌ๊ฒฐ์ • ์ง€์—ฐ, ๋…ผ์˜์˜ ๋น„ํšจ์œจ์„ฑ์œผ๋กœ ์—ฐ๊ฒฐ๋œ๋‹ค. ๊ฒฐ๊ตญ, ํŒ€ ํ”„๋กœ์ ํŠธ๊ฐ€ ์š”๊ตฌํ•˜๋Š” ์‚ฐ์ถœ๋ฌผ์˜ ํ’ˆ์งˆ๊ณผ ํ”„๋กœ์ ํŠธ ์ผ์ •์ด ๋ชจ๋‘ ์•…์˜ํ–ฅ์„ ๋ฐ›๋Š”๋‹ค. ๋ณธ ์„œ๋น„์Šค๋Š” ์ด๋Ÿฌํ•œ ๋ถ€๋‹ด๊ฐ์„ ์™„ํ™”ํ•˜๊ณ , **๋Œ€ํ™” ์ค‘์‹ฌ ํ˜‘์—…์„ ๋น ๋ฅด๊ณ  ๋ชฉํ‘œ์ง€ํ–ฅ์ ์œผ๋กœ ๋งŒ๋“ค๊ธฐ ์œ„ํ•œ ํ™˜๊ฒฝ์„ ์กฐ์„ฑํ•˜๋Š” ๊ฒƒ**์„ ๋ชฉ์ ์œผ๋กœ ํ•œ๋‹ค. + +### ์„œ๋น„์Šค์— ๋Œ€ํ•˜์—ฌ + +๋ณธ ์„œ๋น„์Šค๋Š” ์ต๋ช…์„ฑ์„ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•œ ์‹ค์‹œ๊ฐ„ ์˜์‚ฌ์†Œํ†ต ๋„๊ตฌ๋กœ, ์˜๊ฒฌ ์ œ์‹œ ๊ณผ์ •์—์„œ์˜ ๋ถ€๋‹ด๊ฐ๊ณผ ์‹ฌ๋ฆฌ์  ์ €ํ•ญ์„ ์ตœ์†Œํ™”ํ•˜์—ฌ **์‹ ์†ํ•˜๊ณ  ์ง‘์ค‘๋œ ๋…ผ์˜ ๊ตฌ์กฐ๋ฅผ ๊ตฌํ˜„**ํ•˜๋Š” ๋ฐ ์ดˆ์ ์„ ๋‘”๋‹ค. + +์ต๋ช… ๊ธฐ๋ฐ˜์˜ ํ† ๋ก  ํ™˜๊ฒฝ์€ โ€œ๋‚ด ์˜๊ฒฌ์ด ๋‚˜๋ผ๋Š” ๊ฐœ์ธ์—๊ฒŒ ๊ท€์†๋œ๋‹คโ€๋Š” ์ธ์‹์„ ์ œ๊ฑฐํ•˜์—ฌ ์˜๊ฒฌ ์ œ์‹œ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๊ณ , ๊ณต๊ฒฉยทํ”ผ๊ณต๊ฒฉ์— ๋Œ€ํ•œ ๋ถˆํ•„์š”ํ•œ ๊ฐ์ • ์†Œ๋ชจ๋ฅผ ์ค„์ธ๋‹ค. ๋˜ํ•œ ์‹œ๊ฐ„ ๊ธฐ๋ฐ˜ ์ œํ•œ์„ ๋„์ž…ํ•ด ๋…ผ์˜์˜ ํšจ์œจ์„ฑ์„ ํ™•๋ณดํ•˜๊ณ , ๋ช…ํ™•ํ•œ ์˜์‚ฌ๊ฒฐ์ • ๊ตฌ์กฐ๋ฅผ ํ†ตํ•ด ์‚ฐ์ถœ๋ฌผ ์ƒ์„ฑ์˜ ์†๋„๋ฅผ ๋†’์ธ๋‹ค. + +๋‹ค์Œ ๊ธฐ๋Šฅ๋“ค์€ ์„œ๋น„์Šค์˜ ๋ชฉ์ ์„ ๋‹ฌ์„ฑํ•˜๊ธฐ ์œ„ํ•ด ํ•„์ˆ˜์ ์œผ๋กœ ๊ตฌํ˜„ํ•ด์•ผ ํ•˜๋Š” ์š”์†Œ๋“ค์ด๋‹ค: + +##### โœ” ์‹œ๊ฐ„ ์ œํ•œ ์ต๋ช… ํ† ๋ก ๋ฐฉ + +##### โœ” ์•ˆ๊ฑด ์ •๋ฆฌ ๋ฆฌ์ŠคํŠธ + +##### โœ” ์•ˆ๊ฑด ํˆฌํ‘œ ์‹œ์Šคํ…œ + +## ๊ธฐ์ˆ ์  ์‚ฌํ•ญ + +### ๊ตฌ์กฐ + +| | ์šฉ๋„ | +| --- | --- | +| **Spring boot** | ์›น ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜ ์„œ๋ฒ„ | +| **MySQL** | ์„œ๋น„์Šค ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค | +| **Valkey** | ํ‚ค-๋ฐธ๋ฅ˜ ์Šคํ† ๋ฆฌ์ง€ | + +### Github ์•ก์…˜ + +| | **์šฉ๋„** | +| --- | --- | +| **Backend Manual Build** | ๋ฐฑ์—”๋“œ ๊ตฌํ˜„์ด ๋นŒ๋“œ(gradlew clean build)๊นŒ์ง€ ์„ฑ๊ณต์ ์œผ๋กœ ๊ฐ€๋Šฅํ•œ์ง€ ํ™•์ธ | +| **CodeQL** | ๋ณด์•ˆ ์ทจ์•ฝ์  ๋ฐ ๋ณด์•ˆ ๊ด€๋ จ ๋ฒ„๊ทธ ํ™•์ธ | +| **Dependency Review** | ์‹ฌ๊ฐํ•œ(severe) ์ทจ์•ฝ์ ์ด ํฌํ•จ๋œ ์˜์กด์„ฑ์— ๋Œ€ํ•ด ๊ฒฝ๊ณ  | +| **Docker Compose Test** | ๋„์ปค ์ปดํฌ์ฆˆ ๋นŒ๋“œ ๋ฐ ์‹คํ–‰์ด ์ž˜ ๋˜๋Š”์ง€ ํ™•์ธ | +| **Java Code Style Check** | ์ž๋ฐ” ์ฝ”๋”ฉ ์Šคํƒ€์ผ ํ™•์ธ | + +### ๋ธŒ๋žœ์น˜ ๋ฐ ์ž‘์—…ํ”Œ๋กœ์šฐ ๊ด€๋ฆฌ -> ๐Ÿ’ก **Tip for New Members** -> - ํ•ญ์ƒ `develop` ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—…์„ ์‹œ์ž‘ํ•˜์„ธ์š”. -> - ์ ˆ๋Œ€ `main` ๋ธŒ๋žœ์น˜์— ์ง์ ‘ ์ปค๋ฐ‹ํ•˜์ง€ ๋งˆ์„ธ์š”. -> - ๋ธŒ๋žœ์น˜ ์ด๋ฆ„๋งŒ ๋ด๋„ ์–ด๋–ค ์ž‘์—…์ธ์ง€ ํ•œ๋ˆˆ์— ์•Œ ์ˆ˜ ์žˆ๋„๋ก ์ž‘์„ฑํ•˜์„ธ์š”. +- ๋ธŒ๋žœ์น˜ + - `/docs/README.branch.md` ๋ฅผ ์ฐธ์กฐํ•˜์‹ญ์‹œ์˜ค. ์ด๋Š” ํŒ€์ด ์„ธ์šด ๋ธŒ๋žœ์น˜ ๋ช…๋ช… ๊ทœ์น™ ๋“ฑ์— ๋Œ€ํ•ด ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. + - `/docs/graph.txt`๋ฅผ ์ฐธ์กฐํ•˜์‹ญ์‹œ์˜ค. ์ด๋Š” ํŒ€ ์‚ฐ์ถœ๋ฌผ์— ์˜ํ•œ Git ๊ทธ๋ž˜ํ”„๋ฅผ ๋ณด์—ฌ์ค๋‹ˆ๋‹ค. +- ์ž‘์—… ํ”Œ๋กœ์šฐ ๊ด€๋ฆฌ + - ๋ ˆํฌ์ง€ํ† ๋ฆฌ์˜ Pull request ํƒญ์„ ์ฐธ์กฐํ•˜์‹ญ์‹œ์˜ค. \ No newline at end of file diff --git a/BACKEND_DEPLOYMENT.md b/docs/BACKEND_DEPLOYMENT.md similarity index 100% rename from BACKEND_DEPLOYMENT.md rename to docs/BACKEND_DEPLOYMENT.md diff --git a/docs/README.branch.md b/docs/README.branch.md new file mode 100644 index 0000000..b7ed850 --- /dev/null +++ b/docs/README.branch.md @@ -0,0 +1,29 @@ +## ๐ŸŒฟ Branch ์ „๋žต & ๋„ค์ด๋ฐ ๊ทœ์น™ + +### ๐Ÿ”น Branch ์ข…๋ฅ˜ + +| Branch | ์—ญํ•  | ์„ค๋ช… | +|--------|------|------| +| **main** | ๋ฐฐํฌ์šฉ ๋ธŒ๋žœ์น˜ | ์‹ค์ œ ์„œ๋น„์Šค์— ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์•ˆ์ • ๋ฒ„์ „๋งŒ ์กด์žฌํ•ฉ๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ์ž๋Š” ์ง์ ‘ ์ž‘์—…ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. | +| **develop** | ๊ฐœ๋ฐœ ํ†ตํ•ฉ ๋ธŒ๋žœ์น˜ | ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜๋“ค์„ ๋ณ‘ํ•ฉํ•˜๋Š” ๋ธŒ๋žœ์น˜์ž…๋‹ˆ๋‹ค. ํ…Œ์ŠคํŠธ ์™„๋ฃŒ ํ›„ `main`๋กœ ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค. | +| **feature** | ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜ | ์ƒˆ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ์‹œ `develop`์—์„œ ๋ถ„๊ธฐํ•˜์—ฌ ์ž‘์—… ํ›„ `develop`์— ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค. | +| **release** | ๋ฐฐํฌ ์ค€๋น„ ๋ธŒ๋žœ์น˜ | ๋ฐฐํฌ ์ „ ํ…Œ์ŠคํŠธ, ๋ฌธ์„œ, ๋ฒ„๊ทธ ์ˆ˜์ • ๋“ฑ์„ ์ง„ํ–‰ํ•˜๋ฉฐ ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€๋Š” ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. | +| **hotfix** | ๊ธด๊ธ‰ ์ˆ˜์ • ๋ธŒ๋žœ์น˜ | ๋ฐฐํฌ ํ›„ ๋ฐœ์ƒํ•œ ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •ํ•  ๋•Œ `main`์—์„œ ๋ถ„๊ธฐ ํ›„ `main`, `develop`์— ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค. | + +--- + +### ๐Ÿงฉ ๋„ค์ด๋ฐ ๊ทœ์น™ + +| ์ข…๋ฅ˜ | ์˜ˆ์‹œ | ๊ทœ์น™ | +|------|------|------| +| **main / develop** | ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉ | ํŠน๋ณ„ํ•œ ์ ‘๋‘์‚ฌ ์—†์ด `main`, `develop` ์‚ฌ์šฉ | +| **feature** | `feature/1-login-api`, `feature/2-home-ui` | `feature/{issue-number}-{feature-name}` ํ˜•์‹ ์ถ”์ฒœ | +| **release** | `release-1.2`, `release-RB_1.7` | `release-๋ฒ„์ „๋ช…` ํ˜•์‹ ์‚ฌ์šฉ | +| **hotfix** | `hotfix-1.4.1` | ๊ธด๊ธ‰ ์ˆ˜์ •์šฉ ๋ธŒ๋žœ์น˜. `hotfix-๋ฒ„์ „๋ช…` ํ˜•์‹ ์‚ฌ์šฉ | + +--- + +> ๐Ÿ’ก **Tip for New Members** +> - ํ•ญ์ƒ `develop` ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—…์„ ์‹œ์ž‘ํ•˜์„ธ์š”. +> - ์ ˆ๋Œ€ `main` ๋ธŒ๋žœ์น˜์— ์ง์ ‘ ์ปค๋ฐ‹ํ•˜์ง€ ๋งˆ์„ธ์š”. +> - ๋ธŒ๋žœ์น˜ ์ด๋ฆ„๋งŒ ๋ด๋„ ์–ด๋–ค ์ž‘์—…์ธ์ง€ ํ•œ๋ˆˆ์— ์•Œ ์ˆ˜ ์žˆ๋„๋ก ์ž‘์„ฑํ•˜์„ธ์š”. diff --git a/docs/bravest.png b/docs/bravest.png new file mode 100644 index 0000000..8112ba0 Binary files /dev/null and b/docs/bravest.png differ diff --git a/docs/graph.txt b/docs/graph.txt new file mode 100644 index 0000000..81699a1 Binary files /dev/null and b/docs/graph.txt differ