From d3cc597db96a658f5712837cb9d67510e7732d1a Mon Sep 17 00:00:00 2001 From: Choi seungbin <80771842+csb9427@users.noreply.github.com> Date: Sat, 17 Aug 2024 20:42:25 +0900 Subject: [PATCH] =?UTF-8?q?[INIT]=20=EC=B4=88=EA=B8=B0=20convention=20?= =?UTF-8?q?=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 54 +++++++----------------------------------------------- 1 file changed, 7 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index d55baf05..dfe77c59 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,12 @@ ### πŸ“‘ Architecture -![image](https://github.com/Team-Sopetit/Sopetit-server/assets/80771842/fc4c347d-03fd-4298-a097-3110d36c92ad) ### πŸ“‹ Model Diagram -![image](https://github.com/Team-Sopetit/Sopetit-server/assets/80771842/a260dcff-292b-4dd1-8acd-030a57a57a65) ### πŸ“– Directory -``` -πŸ“ Sopetit-server -β”œβ”€β”€ .github -β”œβ”€β”€ .idea -β”œβ”€β”€ build -β”œβ”€β”€ gen -β”œβ”€β”€ gradel -β”œβ”€β”€ scripts -β”œβ”€β”€ src.main -β”‚ β”œβ”€β”€java.com.soptie.server -β”‚Β Β  β”œβ”€β”€ auth -β”‚Β Β  β”œβ”€β”€ common -β”‚Β Β  β”œβ”€β”€ conversation -β”‚Β Β  β”œβ”€β”€ doll -β”‚Β Β  β”œβ”€β”€ member -β”‚Β Β  β”œβ”€β”€ controller -β”‚Β Β  β”œβ”€β”€ dto -β”‚Β Β  β”œβ”€β”€ entity -β”‚Β Β  β”œβ”€β”€ message -β”‚Β Β  β”œβ”€β”€ repository -β”‚Β Β  β”œβ”€β”€ service -β”‚Β Β  β”œβ”€β”€ memberDoll -β”‚Β Β  β”œβ”€β”€ memberRoutine -β”‚Β Β  β”œβ”€β”€ routine -β”‚Β Β  β”œβ”€β”€ test -β”œβ”€β”€ src.test -β”‚ β”œβ”€β”€java.com.soptie.server -β”‚Β Β  β”œβ”€β”€ auth -β”‚Β Β  β”œβ”€β”€ base -β”‚Β Β  β”œβ”€β”€ doll -β”‚Β Β  β”œβ”€β”€ member -β”‚Β Β  β”œβ”€β”€ memberRoutine -β”‚Β Β  β”œβ”€β”€ controller -β”‚Β Β  β”œβ”€β”€ fixture -β”‚Β Β  β”œβ”€β”€ routine -β”‚Β Β  β”œβ”€β”€ test -``` ### βœ‰οΈ Commit Messge Rules -**μ„œλ²„** λ“€μ˜ **Git Commit Message Rules** +**λŒ•λƒ₯이** λ“€μ˜ **Git Commit Message Rules** - λ°˜μ˜μ‚¬ν•­μ„ λ°”λ‘œ 확인할 수 μžˆλ„λ‘ μž‘μ€ κΈ°λŠ₯ ν•˜λ‚˜λΌλ„ κ΅¬ν˜„λ˜λ©΄ 컀밋을 ꢌμž₯ν•©λ‹ˆλ‹€. - κΈ°λŠ₯ κ΅¬ν˜„μ΄ μ™„λ²½ν•˜μ§€ μ•Šμ„ 땐, 각자 λΈŒλžœμΉ˜μ— 컀밋을 ν•΄μ£Όμ„Έμš”. @@ -79,7 +40,7 @@ ### **πŸ’» Github mangement** -**μ†Œν”„ν‹°** λ“€μ˜ WorkFlow : **Gitflow Workflow** +**λŒ•λƒ₯이** λ“€μ˜ WorkFlow : **Gitflow Workflow** - Develop, Feature, Hotfix 브랜치 @@ -109,15 +70,15 @@ ### ❗️ branch naming convention - develop -- feature/issue_number-도메인-http Method-api -- fix/issue_number-도메인-http Method-api +- feature/issue_number +- fix/issue_number - release/version_number -- hotfix/issue_number - Short Description +- hotfix/issue_number μ˜ˆμ‹œ > ``` - feature/#3-user-post-api + feature/#3 ``` ### πŸ“‹ Code Review Convention @@ -137,8 +98,7 @@ ### πŸ‘©β€πŸ‘§β€πŸ‘§ Our Team -| **πŸ€ [졜승빈](https://github.com/csb9427)** | **πŸ€ [남ꢁ찬](https://github.com/Chan531)** |**πŸ€ [κΉ€μ†Œν˜„](https://github.com/thguss)** | +| **πŸ€ [졜승빈](https://github.com/csb9427)** | **πŸ€ [κΉ€μˆ˜μ˜](https://github.com/sootudio)** |**πŸ€ [κΉ€μ•„μ˜](https://github.com/a-young-kim)** | |:-----------------------------------:|:-----------------------------------:|:-----------------------------------:| | Server Developer | Server Developer | Server Developer | -| ![image](https://github.com/Team-Sopetit/Sopetit-server/assets/80771842/4eaa9aaa-b834-4883-91c8-cb5dd3005c5d) | ![image](https://github.com/Team-Sopetit/Sopetit-server/assets/80771842/3e82a81c-1710-4199-8c5c-c920fdb8229b) | ![image](https://github.com/Team-Sopetit/Sopetit-server/assets/80771842/ca9420e7-744d-4725-a9d9-36f79669fd04) | | ν”„λ‘œμ νŠΈ μ„ΈνŒ…
| ν”„λ‘œμ νŠΈ μ…‹νŒ…
| ν”„λ‘œμ νŠΈ μ„ΈνŒ…
|