From 1103e218b7fe47a2b300686ad940d61d710d6521 Mon Sep 17 00:00:00 2001
From: Minwoo Moon <121410579+Minuooooo@users.noreply.github.com>
Date: Mon, 2 Dec 2024 10:36:12 +0900
Subject: [PATCH] docs: edit
---
README.md | 83 +++++++++++++++----------------------------------------
1 file changed, 22 insertions(+), 61 deletions(-)
diff --git a/README.md b/README.md
index 8b26b78..15b1496 100644
--- a/README.md
+++ b/README.md
@@ -1,72 +1,33 @@
-## 개발 환경
-|분류|내용|
-|:---|:---|
-|Java version|11.0.20-amzn|
-|Database|MySQL|
-|Framework|Spring-boot '2.7.13'|
-|빌드 관리 도구|Gradle|
-|패키지 구조|DDD|
-|배포|Docker, AWS-EC2|
-|CI/CD|GitHub Actions|
-|기타|AWS-RDS, AWS-S3|
-|개발 Tool|IntelliJ|
-|협업 Tool|GitHub, Notion, Figma, Discord|
-
-
-
-## System Architecture
+## 시스템 아키텍처
-
-
-
-## ERD
-
-
-
-
-
-## API 명세서
-[Docs](https://secret-enquiry-5de.notion.site/API-9fb86b9227b24311a6b9dcd6bba31bcc?pvs=4)
-
-## Backend Convention
+## 컨벤션
### Issues
-✓ `Ex. Title`
-
-- 기능 개발, 오류 수정 등의 Issue 생성
-- Issue number 확인 (#1, 2, 3..)
-- 트러블 슈팅을 위해 오류에 대한 Issue를 생성하고, 해결 과정 문서화
-
-
+- 기능 개발, 오류 수정 등의 이슈 생성
+- 이슈 번호 확인
+- 트러블 슈팅 기록
### Branch
-✓ `Ex. Type/#Issue.number-Title`
-
-- `master` : 최종본
-- `env` : 환경 설정
-- `feat` : 이슈 별 기능 개발
-- `refactor` : 리팩토링
-- `fix` : 오류 수정
-- `test` : 테스트 코드 작성
-
-
-
-### Commit Message
-✓ `Ex. [ Type ] Title`
-
-- `env` : 환경 설정
-- `feat` : 기능 개발
-- `refactor` : 리팩토링
-- `fix` : 오류 수정
-- `chore` : Gradle 설정, 기타 작업
-- `test` : 테스트 코드 작성
-
-
+-Type/#Issue.number-Title
+- master: 최종본
+- env: 환경 설정
+- feat: 이슈 별 기능 개발
+- refactor: 리팩토링
+- fix: 오류 수정
+- test: 테스트 코드 작성
+
+### Commit
+-[Type] Title
+- env: 설정
+- feat: 기능 개발
+- refactor: 리팩토링
+- fix: 오류 수정
+- chore: gradle 설정, 기타 작업
+- test: 테스트 코드
### PR
-✓ `Ex. [#Issue.number] Type: Title`
-
+-[#Issue.number] Type: Title
## 😁 Team