Docs: 리드미 작성

Author: goodjunseon

README.md

@@ -1,2 +1,58 @@
-# 7-ToGetHer
-ToGetHer-BE 레포지토리입니다.
+## 👩🏼‍❤️‍👨🏼 ToGetHer
+### 우리의 피임, 함께라서 더 안전하고 편안하게.
+
+---
+
+## 📌 Main Function
+
+작성중...
+
+---
+
+## 
+
+---
+
+
+## ✨ Contributors
+
+| 항목       | 박준선 | 임승우 |
+|------------|--------|--------|
+| **프로필**   | <img src="https://github.com/goodjunseon.png" width="100"> | <img src="https://github.com/swoo0514.png" width="100"> |
+| **GitHub**  | [@goodjunseon](https://github.com/goodjunseon) | [@Lims](https://github.com/swoo0514) |
+
+---
+## 🔗Architecture
+
+작성중...
+
+---
+
+## 📀 ERD
+
+작성중...
+
+---
+
+## 🤝🏻 Git Convention
+### [Git Convention](document/GitConvention)
+
+---
+## 🤝🏻 Code Convention
+### [Code Convention](document/CodeConvetion.md)
+
+---
+## Tech Stack
+[![My Skills](https://skillicons.dev/icons?i=java,spring)](https://skillicons.dev)
+
+[![My Skills](https://skillicons.dev/icons?i=mysql,redis)](https://skillicons.dev)
+
+[![My Skills](https://skillicons.dev/icons?i=aws,linux,nginx)](https://skillicons.dev)
+
+[![My Skills](https://skillicons.dev/icons?i=github,git,githubactions)](https://skillicons.dev)
+
+[![My Skills](https://skillicons.dev/icons?i=idea,postman,figma,discord,notion)](https://skillicons.dev)
+
+---
+## 📁 Folder Structure
+

document/CodeConvetion.md

@@ -0,0 +1,32 @@
+## 🤙🏻 Code Convention
+
+> ### 📌 Naming 규칙
+> 변수명, 메서드명에는 영어와 숫자만 사용하며, 소문자 카멜 케이스를 기본적으로 사용합니다.
+> - 메서드 이름은 동사/전치사로 시작합니다.
+> - 클래스명/인터페이스명에는 대문자 카멜표기법을 사용합니다.
+>   - good: Store.class (O) 
+>   - bad: store.class (X)
+> - 클래스명은 명사로 한정합니다.
+>   - 한국어 발음대로 표기 금지
+>     - good: Sharing.class (O)
+>     - bad: Gongyu.class (X)
+> - 패키지 이름은 소문자로 구성합니다.
+
+> ### 📌 Declaration 규칙
+> - 한줄에 한 문장만을 작성, 문장이 끝나는 ( **;** ) 뒤에는 새 줄을 삽입합니다.
+>   - int a = 1; int b = 2; 처럼 작성 금지
+> - 배열 선언에 오는 대괄호는 타입 뒤에 선언합니다.
+>   - good: String[ ] names;
+>   - bad: String names[ ]
+>   - 'long'형 값의 마지막에 'L' 붙이기
+>   - good: long number = 123L;
+
+> ### 📌 RestAPI 작성 규칙
+> - API 엔드 포인트에는 동사 대신 명사를 사용합니다.
+>   - HTTP 요청 메서드에 의미가 내포되어 있기 때문에 동작을 작성하지 않아도 됨
+>     - good: [GET] /users  [POST] /users
+>     - bad: [GET] /getUsers [POST] /createUsers
+> - 주소가 길어지는 경우 밑줄( _ )보다는 하이픈( - )을 사용합니다.
+> - 엔드포인트 경로에는 소문자만 사용합니다.
+
+

document/GitConvention.md

@@ -0,0 +1,34 @@
+## 🤙🏻 Git Branch & Commit Convention
+
+### 📌 Branch Strategy 
+
+> ### Main Branch
+> 1. **main**: 운영(deploy)용 브랜치. 실제 서비스에 배포되는 안정적인 코드
+> 2. **dev** : 개발 브랜치, 기능 브랜치들이 병합되는 공간, 테스트 후 main으로 병합합니다.
+
+> ### Feature Branches
+>  3. **feat/**: 새로운 기능을 개발할 때 사용
+>  4. **fix/**: 버그나 오류를 수정할 때 사용
+>  4. **refactor/**: 코드 리팩토링 시 사용
+
+### 📌 Naming Convetion
+> **이슈번호/feat/기능명**
+
+---
+### 📌 Commit Convention
+> 1. 커밋 유형은 아래와 같이 작성합니다.
+> 2. 제목과 본문을 빈행으로 분리합니다.
+> 3. 제목의 첫 글자는 대문자로 작성하고, 제목 끝에 마침표(.)를 금지한다.
+
+| 커밋 유형 | 의미 |
+| --- | --- |
+| `Feat` | 새로운 기능 추가 |
+| `Fix` | 버그 수정 |
+| `Docs` | 문서 수정 |
+| `Style` | 코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우 |
+| `Refactor` | 코드 리팩토링 |
+| `Test` | 테스트 코드, 리팩토링 테스트 코드 추가 |
+| `Comment` | 필요한 주석 추가 및 변경 |
+| `Rename` | 파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우 |
+| `Remove` | 파일을 삭제하는 작업만 수행한 경우 |
+| `!HOTFIX` | 급하게 치명적인 버그를 고쳐야 하는 경우 |