Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

๐Ÿ“‘ README Branch Convention ์ˆ˜์ • #8

Merged
merged 2 commits into from
Apr 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 57 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## ๐Ÿ’ฐ Pennyway

> ์ง€์ถœ ๊ด€๋ฆฌ SNS ํ”Œ๋žซํผ

| Version # | Revision Date | Description | Author |
|:---------:|:-------------:|:--------------|:------:|
| Version # | Revision Date | Description | Author |
| :-------: | :-----------: | :---------------------- | :----: |
| v0.0.1 | 2024.03.11 | ํ”„๋กœ์ ํŠธ ๊ธฐ๋ณธ ์„ค๋ช… ์ž‘์„ฑ | ์ด์˜์ฐฌ |

<br/>
Expand All @@ -28,71 +29,102 @@
</tr>
</table>


<br/>

## ๐ŸŒณ Branch Convention

> ๐Ÿ’ก Github-Flow ์ „๋žต์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
- main
- ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ์˜ ์ฝ”๋“œ๋งŒ์„ ๊ด€๋ฆฌํ•˜๋Š” ํ”„๋กœ๋•์…˜์šฉ ๋ธŒ๋žœ์น˜
- PM(์–‘์žฌ์„œ)์˜ ์Šน์ธ ํ›„ ๋ณ‘ํ•ฉ ๊ฐ€๋Šฅ
- develop
- ๊ฐœ๋ฐœ ์ „์šฉ ๋ธŒ๋žœ์น˜
- ํ•œ ๋ช… ์ด์ƒ์˜ ํŒ€์›์˜ ์Šน์ธ ํ›„ ๋ณ‘ํ•ฉ ๊ฐ€๋Šฅ
- ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์ด ์™„๋ฃŒ๋œ ๋ธŒ๋žœ์น˜๋ฅผ ๋ณ‘ํ•ฉํ•˜์—ฌ ํ…Œ์ŠคํŠธ๋ฅผ ์ง„ํ–‰
- ์ด์Šˆ ๊ธฐ๋ฐ˜ ๋ธŒ๋žœ์น˜
- ์ด์Šˆ๋Š” `{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`์„ ํฌํ•จํ•œ๋‹ค.

- main ๋ธŒ๋žœ์น˜ (default)

- ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ์˜ ์ฝ”๋“œ๋งŒ์„ ๊ด€๋ฆฌํ•˜๋Š” ํ”„๋กœ๋•์…˜์šฉ ๋ธŒ๋žœ์น˜
- PM(์–‘์žฌ์„œ)์˜ ์Šน์ธ ํ›„ ๋ณ‘ํ•ฉ ๊ฐ€๋Šฅ
- ๊ธฐ๋Šฅ ์ถ”๊ฐ€์™€ ๊ด€๋ จ๋œ PR์— ๋Œ€ํ•ด **๋ฐ˜๋“œ์‹œ ๋ฆฌ๋ทฐ์–ด** ๋“ฑ๋ก
- **MVP release ์ดํ›„์—๋Š” ๋ชจ๋“  PR**์— ๋Œ€ํ•ด ๋ฆฌ๋ทฐ์–ด ๋“ฑ๋ก

- ์ž‘์—… ๋ธŒ๋žœ์น˜

- ํ‹ฐ์ผ“์ด ํฌํ•จ๋œ ์ž‘์—…์€ `{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`๋กœ ๋ธŒ๋žœ์น˜ ๋ช…์„ ์ž‘์„ฑํ•œ๋‹ค.
- `feat/{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`: ์‹ ๊ทœ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ์‹œ ๋ธŒ๋žœ์น˜๋ช…
- `fix/{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`: ๋ฆฌํŒฉํ† ๋ง, ์ˆ˜์ • ์ž‘์—… ์‹œ ๋ธŒ๋žœ์น˜๋ช…
- `fix/{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`: ์ˆ˜์ • ์ž‘์—… ์‹œ ๋ธŒ๋žœ์น˜๋ช…
- `refactor/{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`: ๋ฆฌํŒฉํ† ๋ง ์ž‘์—… ์‹œ ๋ธŒ๋žœ์น˜๋ช…
- `hotfix/{ํ‹ฐ์ผ“๋ฒˆํ˜ธ}-{๋ธŒ๋žœ์น˜๋ช…}`: ๋น ๋ฅด๊ฒŒ ์ˆ˜์ •ํ•ด์•ผ ํ•˜๋Š” ๋ฒ„๊ทธ ์กฐ์น˜ ์‹œ ๋ธŒ๋žœ์น˜๋ช…
- ๋ฆด๋ฆฌ์ฆˆ ๋ธŒ๋žœ์น˜
- ๋ฐฐํฌ๋ฅผ ์œ„ํ•œ ์ตœ์ข…์ ์ธ ๋ฒ„๊ทธ ์ˆ˜์ • ๋“ฑ์˜ ๊ฐœ๋ฐœ์„ ์ˆ˜ํ–‰ํ•˜๋Š” ๋ธŒ๋žœ์น˜
- ํ‹ฐ์ผ“์ด ํฌํ•จ๋˜์ง€ ์•Š์€ ์ž‘์—…์€ ๋ช…ํ™•ํ•œ `๋ธŒ๋žœ์น˜๋ช…`์„ ์ž‘์„ฑํ•œ๋‹ค.
- `fix/{๋ธŒ๋žœ์น˜๋ช…}`
- `hotfix/{๋ธŒ๋žœ์น˜๋ช…}`

<br/>

## ๐Ÿค Commit Convention

> ๐Ÿ’ก angular commit convention
- feat: ์‹ ๊ทœ ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- fix: ๋ฒ„๊ทธ ์ˆ˜์ •
- docs: ๋ฌธ์„œ ์ˆ˜์ •
- style: ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ (์ฝ”๋“œ ๋ณ€๊ฒฝ ์—†๋Š” ๊ฒฝ์šฐ)
- refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
- test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
- chore: ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •

- feat: ์‹ ๊ทœ ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- fix: ๋ฒ„๊ทธ ์ˆ˜์ •
- docs: ๋ฌธ์„œ ์ˆ˜์ •
- style: ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ (์ฝ”๋“œ ๋ณ€๊ฒฝ ์—†๋Š” ๊ฒฝ์šฐ)
- refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
- test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
- chore: ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •

## ๐Ÿ“Œ Architecture
### FSD Architecture

### 1๏ธโƒฃ FSD Architecture

> ๐Ÿ’ก FSD Architecture๋ฅผ ์ปค์Šคํ…€ํ•˜์—ฌ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

- widgets, features, entities 3๋‹จ๊ณ„๋ฅผ ํ†ตํ•ฉํ•ด components๋‹จ๊ณ„๋กœ ์„ค์ •ํ•˜์˜€์Šต๋‹ˆ๋‹ค.
<div align="center">
<img src="https://github.com/Legitgoons/Legitgoons/assets/101088491/99d1490e-7066-41cf-8f8a-70326627ea1f" width="600">
</div>
<br/>

### 2๏ธโƒฃ CI/CD Pipeline

<div align="center">
<img src="https://github.com/CollaBu/pennyway-client-webview/assets/44726494/27904f85-6bdf-49ec-a08d-54821827f6fe" alt="ci pipeline" width="600" />
<img src="https://github.com/CollaBu/pennyway-client-webview/assets/44726494/37d03add-2956-466e-a100-549168860cad" alt="cd pipeline" width="600" />
</div>

## ๐Ÿ“— Tech Stack

### 1๏ธโƒฃ Language
### 1๏ธโƒฃ Language

- TypeScript v5.3.3

### 2๏ธโƒฃ Framework & Library

- Node v18.18.0
- React v18.2.0
- React Query v5.25.0
- Axios v1.6.7

### 3๏ธโƒฃ Style Sheet

- Sass v1.71.1

### 4๏ธโƒฃ Code Formatting & Linting Tools

- Prettier v3.2.5
- ESLint v8.57.0

### 5๏ธโƒฃ Build & Deployment Tools

- Vite v5.1.5
- Amazon EC2

### 6๏ธโƒฃ Automation & Test Framework

- GitHub Actions
- Vitest v1.4.0

### 7๏ธโƒฃ Mocking Library

- MSW v2.2.13

### 8๏ธโƒฃ Collaboration & Project Management Tools

- GitHub
- Jira
- Confluence
- Discord
- Discord
Loading