DOCS: 변경 내용 문서 수정

prgrms-web-devcourse-final-project · Dec 11, 2024 · 4730adb · 4730adb
1 parent 8c0b0c7
commit 4730adb
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -2,20 +2,25 @@
 
 ![프로젝트이미지](https://github.com/user-attachments/assets/6e0bdf74-a374-4c70-952d-fc22e0ba3413)
 
+### 버전 및 개발 기간
+* v1.0.0: 2024/11/18 ~ 2024/12/09
+* v1.1.0: 2024/12/19 ~ 2024/12/31
+* v2.0.0: 2025/01/01 ~ (예정)
+
+<br>
+
 ## 🍀 프로젝트 소개
-아이주주는 초등학생들이 돈과 투자의 기본 개념을 쉽고 재미있게 배울 수 있도록 설계된 모의투자 학습 플랫폼입니다.
+아이주주는 초등학생들이 돈과 투자의 기본 개념을 쉽고 재미있게 배울 수 있도록 설계된  
+모의투자 학습 플랫폼입니다.
 
 [🔗 기획서](https://www.notion.so/13f336d06fda80d4a0dfc9e9ac30e96b?pvs=4)
-[🔗 디자인](https://www.figma.com/design/HfCXjOdS1CcDWLJbhci0dI/%EC%95%84%EC%9D%B4%EC%A3%BC%EC%A3%BC-%EC%99%80%EC%9D%B4%EC%96%B4%ED%94%84%EB%A0%88%EC%9E%84?node-id=0-1&t=WB1ZEVppjZTp8DY5-1)
+[🔗 와이어프레임](https://www.figma.com/design/HfCXjOdS1CcDWLJbhci0dI/%EC%95%84%EC%9D%B4%EC%A3%BC%EC%A3%BC-%EC%99%80%EC%9D%B4%EC%96%B4%ED%94%84%EB%A0%88%EC%9E%84?node-id=0-1&t=WB1ZEVppjZTp8DY5-1)
 [🔗 프론트 깃허브](https://github.com/prgrms-web-devcourse-final-project/WEB1_2_Child-Learn_FE)
 [🔗 백엔드 깃허브](https://github.com/prgrms-web-devcourse-final-project/WEB1_2_Child-Learn_BE)
 [🔗 아이주주 바로가기](http://ijuju.site)
 
-### 개발기간 : 2024/11/18 ~ 2024/12/09
-
 <br>
 
-
 ## 🍀 주요 기능
 > **주식 그래프**
 - **그래프 및 데이터 제공:** 종목별 투자 그래프와 비유적 설명이 담긴 뉴스레터 제공
@@ -35,7 +40,7 @@
 - 여러가지 아이템으로 흥미 제공.
 
 <br>
- 
+
 ## 🍀 개발 환경 및 기술 스택
 ### 통합 시스템 아키텍처
 ![통합 시스템 아키텍처](https://github.com/user-attachments/assets/f6ddd958-6a68-4305-84c3-3e6f8098633f)
@@ -45,32 +50,36 @@
 ## 🍀 개발 문서
 <details>
   <summary>ERD</summary>
+
+[🔗 ERD 바로가기](https://www.erdcloud.com/d/FrEWNLqLuTPQ6rx2r)
+![ERD](https://github.com/user-attachments/assets/a3ab7508-4e59-48d0-9b99-f068861037ce)
+
 </details>
 <details>
-  <summary>아키텍처</summary>
+  <summary>인프라 아키텍처</summary>
 
-![백엔드 서버 아키텍처](https://github.com/user-attachments/assets/f96d2c88-223c-47b4-a673-ac613be39063)
+![백엔드 인프라 아키텍처](https://github.com/user-attachments/assets/f96d2c88-223c-47b4-a673-ac613be39063)
 
 </details>
 <details>
   <summary>요구사항 명세서</summary>
 
-[🔗 요구사항 명세서](https://foggy-move-190.notion.site/67c1e522ca8047d98094580d9bdc8f87?pvs=74)
+[🔗 요구사항 명세서 바로가기](https://foggy-move-190.notion.site/67c1e522ca8047d98094580d9bdc8f87?pvs=74)
 </details>
 <details>
   <summary>API 명세서</summary>
 
-[🔗 API 명세서](https://foggy-move-190.notion.site/API-b44b55ec93c9478c9a25c9f75150b773?pvs=73)
+[🔗 API 명세서 바로가기](https://foggy-move-190.notion.site/API-b44b55ec93c9478c9a25c9f75150b773?pvs=73)
 </details>
 
 ## 🍀 팀 소개
 
 ### FRONTEND
-|                           👑 이희주                           |                           📋 박우현                           |                  류민주                  |
-|:----------------------------------------------------------:|:----------------------------------------------------------:|:-------------------------------------:|
-|                       FE TeamLeader                        |                             PM                             |               Git_Admin               |
-|          [tree0000](https://github.com/tree0000)           |         [hjlee2778](https://github.com/hjlee2778)          | [minij02](https://github.com/minij02) |
-| ![](https://avatars.githubusercontent.com/u/141895600?v=4) | ![](https://avatars.githubusercontent.com/u/144092849?v=4) | ![](https://avatars.githubusercontent.com/u/135093109?v=4)|
+|                           👑 이희주                           |                           📋 박우현                           |                             류민주                             |
+|:----------------------------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------------------:|
+|                       FE TeamLeader                        |                             PM                             |                          Git_Admin                          |
+|          [hjlee2778](https://github.com/hjlee2778)           |         [tree0000](https://github.com/tree0000)          |            [minij02](https://github.com/minij02)            |
+| ![](https://avatars.githubusercontent.com/u/144092849?v=4) | ![](https://avatars.githubusercontent.com/u/141895600?v=4) | ![](https://avatars.githubusercontent.com/u/135093109?v=4)  |
 
 ### BACKEND
 |              👑 임지은               |                    신은화                    |               최재형                |                   이수빈                   |                   박찬서                   |

diff --git a/docs/branch-strategy.md b/docs/branch-strategy.md
@@ -12,39 +12,34 @@
 ### 브랜치 네이밍
 * Issue 에서 브랜치 생성
 * main : 프로젝트가 최종적으로 배포되는 중심 브랜치입니다.
-* dev : 개발이 진행되는 브랜치입니다. dev 브랜치가 배포할 수준의 기능을 갖추면 release 브랜치로 머지됩니다.
+* develop : 개발이 진행되는 브랜치입니다. dev 브랜치가 배포할 수준의 기능을 갖추면 release 브랜치로 머지됩니다.
 * feature : 기능을 개발하는 브랜치입니다. dev 브랜치에서 파생되는 브랜치이며, dev 브랜치로 머지합니다.
-* release 브랜치에서 모든 테스트가 통과한 후 main 브랜치로 병합
-  * CI/CD가 되어 있는 상태에서 바로 main 브랜치로 병합 시 배포 실패가 뜨는 것을 방지하고,
-    추가 에러가 있는지 확인하는 과정이라고 생각해주세요.
-* hotfix 브랜치는 배포 된 후 생긴 에러의 긴급 상황에서 사용, 즉시 테스트 및 배포되어야 함
-* 필요 시 작업 별로 구분하기 위해서 Issue Tracker ID 사용  
-  `dev/feat/{기능명}/{#이슈번호}`
-
-| 분류 | 내용 | 명명규칙 |
-| --- | --- | --- |
-| main | 최종적으로 배포되는 브랜치 | main |
-| develop | 개발 중인 코드가 모이는 브랜치 | dev |
-| feature | 새로운 기능을 개발하는 브랜치 | dev/feature/{기능명} /{#이슈번호} |
-| refactor | 개발된 기능을 리팩터링하는 브랜치 | dev/refactor/{기능명}/{#이슈번호} |
+* release : 배포 전 버전 기록을 남깁니다. 브랜치에서 모든 테스트가 통과한 후 main 브랜치로 병합
+* hotfix : 브랜치는 배포 된 후 생긴 에러의 긴급 상황에서 사용, 즉시 테스트 및 배포되어야 함
+* 작업 별로 구분하기 위해서 SCRUM-NUM 사용  
+  `feature/{도메인}/{#스크럼번호}`
+| 분류 | 내용 | 명명규칙                        |
+| --- | --- |-----------------------------|
+| main | 최종적으로 배포되는 브랜치 | main                        |
+| develop | 개발 중인 코드가 모이는 브랜치 | develop                     |
+| feature | 새로운 기능을 개발하는 브랜치 | feature/{도메인}/{#스크럼번호}      |
+| refactor | 개발된 기능을 리팩터링하는 브랜치 | refactor/{도메인}/{#스크럼번호} |
 | release | 배포를 준비하는 브랜치 | release/{버전} |
-| hotfix | 배포 된 후 발생한 버그를 수정하는 브랜치 | hotfix/(#이슈번호) |
-
-※ 배포를 준비하는 브랜치는 dev 또는 release 에서 현재와 다르게 추후 변경될 수 있습니다.
+| hotfix | 배포 된 후 발생한 버그를 수정하는 브랜치 | hotfix/(#이슈번호)              |
 
 <br>
 
 ### 활용 예시
 ```markdown
 main
 
-dev/feature/login/#1
+develop
 
-dev/feature/register/#12
+feature/register/#12
 
-dev/refactor/login
+refactor/login
 
-release/1.0.0
+release/V1.0.0
 
 hotfix/#22
 ```
diff --git a/docs/commit-convention.md b/docs/commit-convention.md
@@ -17,21 +17,19 @@ footer
 
 ### The Type
 
-| 타입 | 설명 |
-| --- | --- |
-| Feat | 새로운 기능 |
-| Fix | 버그 수정 |
-| Docs | 문서 변경 사항 |
-| Style | 서식, 세미콜론 누락 등; 코드 변경 없음, 파일, 폴더명 변경 및 이동, 제거 |
-| Refactor | 프로덕션 코드 리팩토링 |
-| Test | 테스트 추가, 테스트 리팩토링; 프로덕션 코드 변경 없음 |
+| 타입 | 설명                                      |
+| --- |-----------------------------------------|
+| Feat | 새로운 기능                                  |
+| Fix | 버그 수정                                   |
+| Refactor | 프로덕션 코드 리팩토링                            |
+| Test | 테스트 추가, 테스트 리팩토링; 프로덕션 코드 변경 없음         |
 | Chore | 빌드 작업, 패키지 관리자 구성 등 업데이트, 프로덕션 코드 변경 없음 |
-| | |
-| Add | 코드 추가 |
-| Modify | 코드 수정 |
+| Docs | 문서 변경 사항                                |
+| Style | 서식, 세미콜론 누락, 주석 추가 및 제거 등; 코드 변경 없음     |
+| Modify | 코드 추가 및 수정, 파일 또는 폴더명 변경 및 이동, 제거       |
 
 ※ Merge Commit Message는 기본 세팅을 따른다.  
-※ Add, Modify는 Feat 으로 새로운 기능 추가 후 추가 수정 시 사용
+※ Modify는 Feat 으로 새로운 기능 추가 후 추가 수정 시 사용
 
 <br>
 
@@ -42,12 +40,12 @@ footer
 * 문장의 끝에 마침표를 사용하지 않음
 * 명령형
 * 태그: 제목 형식으로 커밋 내용을 유의미하게 전달
-* Type:  (도메인)-(구현내용)
-* 파일명, 도메인은 영문 그대로 사용
+* Type:  (도메인) (구현내용)
+* 파일명, 도메인은 영문 그래도 사용
 * 내용은 최대한 한글 사용
 
 ```
-Feat: friend-친구 목록 기능 구현
+Feat: friend 친구 목록 기능 구현
 
 * 친구 목록 조회 기능
 * 친구 신청 기능
@@ -82,7 +80,7 @@ Feat: friend-친구 목록 기능 구현
 ### Example Commit Message
 
 ```
-Feat: member-로그인 기능 구현
+Feat: member 로그인 기능 구현
 
 로그인 시 JWT 발급