Skip to content

softeerbootcamp4th/Team5-WatermelonClap-BE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3a41740 ยท Sep 3, 2024
Sep 3, 2024
Aug 26, 2024
Aug 26, 2024
Jul 18, 2024
Aug 26, 2024
Sep 3, 2024
Aug 22, 2024
Jul 18, 2024
Sep 1, 2024
Aug 23, 2024
Jul 18, 2024
Jul 19, 2024
Jul 18, 2024
Aug 19, 2024

Repository files navigation

ํ˜‘์—… ๊ด€๋ จ

๐Ÿ“Œ github ๊ทœ์น™

  • main์— ์ปค๋ฐ‹ ๊ธˆ์ง€(๋ณดํ˜ธ ๊ฑธ์–ด๋†“์Œ, ๋ฉ”์ธ ๋นŒ๋“œ์šฉ)
  • ๋ธŒ๋žœ์น˜ ๋„ค์ด๋ฐ ์ปจ๋ฒค์…˜ ์ค€์ˆ˜
    • ์ด์Šˆ ๋ฒˆํ˜ธ
    • WB-1

๐Ÿ“Œ ์ด์Šˆ ๊ด€๋ฆฌ

  • JIRA ํ™œ์šฉ
    • ์—ํ”ฝ์„ ์Šคํ”„๋ฆฐํŠธ ๋‹จ์œ„๋กœ ํ•œ๋‹ค.
    • ์—ํ”ฝ์€ ๋„๋ฉ”์ธ ๋‹จ์œ„๋กœ ํ•œ๋‹ค.
    • ์Šคํ”„๋ฆฐํŠธ๋Š” 1์ฃผ์ผ์˜ ์ฃผ๊ธฐ๋ฅผ ๊ฐ€์ง„๋‹ค.
    • ์Šคํ”„๋ฆฐํŠธ ์‹œ์ž‘ ์‹œ ๋ฐฑ๋กœ๊ทธ์—์„œ ์ด๋ฒˆ์ฃผ์— ์ง„ํ–‰ํ•  ์ž‘์—…์„ ๊ฐ€์ ธ์™€ ์Šคํ”„๋ฆฐํŠธ์— ์ฑ„์šด๋‹ค.
    • ์Šคํ”„๋ฆฐํŠธ ์ข…๋ฃŒ ์‹œ ํšŒ๊ณ ๋ฅผ ํ†ตํ•ด ์ž‘์—… ์ง„ํ–‰์†๋„ ๋ฐ ์ž‘์—… ๋ถ„๋ฐฐ์— ๋Œ€ํ•ด ๋…ผ์˜ํ•œ๋‹ค.
image

๐Ÿ“Œ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

๊ธฐ๋ณธ ๊ทœ์น™:

๋ผ๋ฒจ๋ช…[์„œ๋ฒ„ ์ข…๋ฅ˜]: ํ•œ ์ค„์งœ๋ฆฌ description `๋‹จ, ๊ฐœ๋ฐœ ์šฉ์–ด๋ฅผ ์ œ์™ธํ•˜๊ณ ๋Š” ๋ฌด์กฐ๊ฑด ํ•œ๊ธ€๋งŒ ํ—ˆ์šฉ`

- ์„ค๋ช… 1(์ตœ๋Œ€ํ•œ ์ž์„ธํ•˜๊ฒŒ)
- ์„ค๋ช… 2

๋ผ๋ฒจ ์„ค๋ช…

feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ ๋ฐ ์‚ญ์ œ. ์‚ฌ์šฉ์ž๊ฐ€ ์กฐ๊ธˆ์ด๋ผ๋„ ๋ณ€ํ™”๋ฅผ ๊ฐ์ง€ํ•  ์ˆ˜ ์žˆ์œผ๋ฉด ๋ฌด์กฐ๊ฑด feat๋กœ ๋ถ„๋ฆฌ.
fix: ๋ฒ„๊ทธ ์ˆ˜์ •
refactor: feat์™€ fix๋ฅผ ์ œ์™ธํ•œ ๋ชจ๋“  ์ฝ”๋“œ ์ˆ˜์ •
chore: ๋ณ„๋กœ ์ค‘์š”ํ•˜์ง€ ์•Š์€ ๋ณ€๊ฒฝ ์‚ฌํ•ญ `e.g., ํŒŒ์ผ๋ช… ๋ณ€๊ฒฝ, ํด๋” ๊ตฌ์กฐ ๋ณ€๊ฒฝ, ์˜คํƒ€ ์ˆ˜์ •, ์ฃผ์„ ์ œ๊ฑฐ, etc.`
build: ๋นŒ๋“œ ๊ด€๋ จ ์„ค์ •
config: ๊ฐœ๋ฐœํ™˜๊ฒฝ ๊ด€๋ จ ์„ค์ •(ํ”„๋กœ์ ํŠธ ์ดˆ๊ธฐ ์„ค์ •๋„ ํฌํ•จ)
style: ์ฝ”๋“œ  
res: ๋ฆฌ์†Œ์Šค ๊ด€๋ จ (String, Color ๋“ฑ) ํŒŒ์ผ `์•ˆ๋“œ๋กœ์ด๋“œ ํ•œ์ •`

์„œ๋ฒ„ ์ข…๋ฅ˜ ์„ค๋ช…

[api-server] : api ์„œ๋ฒ„
[gateway-server] : gateway ์„œ๋ฒ„
[all] : ๋ ˆํฌ ์ „์ฒด ์ ์šฉ ex) README

์ปค๋ฐ‹ ํ•œ๋ฒˆ์—๋Š” 100์ค„ ์ด์ƒ์˜ ๋ณ€ํ™”๋ฅผ ๋„ฃ์ง€ ์•Š๋Š”๋‹ค.


๐Ÿ“Œ PR ๊ทœ์น™

  • ์ƒ์œ„ ์ด์Šˆ ํ•˜๋‚˜๋ฅผ ํ•ด๊ฒฐํ•˜๋ฉด PR๋กœ ์˜ฌ๋ฆฐ๋‹ค.
  • PR์„ ๊ธฐ์ค€์œผ๋กœ CI/CD๊ฐ€ ์ž‘๋™ํ•˜๋ฏ€๋กœ ํƒ€ ํŒจํ‚ค์ง€์— ๋ถˆํ•„์š”ํ•œ ์ˆ˜์ •์„ ํ•˜์ง€ ์•Š๋Š”๋‹ค.
  • ์ตœ์†Œ ํ•œ๋ช…์˜ Reviewer์„ ์„ค์ •ํ•œ๋‹ค.
  • ํ•ด๋‹น Reviewer์˜ Approve์™€ ๋นŒ๋“œ ๋ฐ ํ…Œ์ŠคํŠธ ์„ฑ๊ณต์ด ๋˜์—ˆ์„ ๊ฒฝ์šฐ์—๋งŒ Merge ๊ฐ€๋Šฅ

๐Ÿ“Œ PR ํ…œํ”Œ๋ฆฟ

## ์—ฐ๊ด€๋œ ์ด์Šˆ

- ex) #์ด์Šˆ๋ฒˆํ˜ธ, #์ด์Šˆ๋ฒˆํ˜ธ

## ์ž‘์—… ๋‚ด์šฉ

- ์ด๋ฒˆ PR์—์„œ ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ ๊ฐ„๋žตํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”(์ด๋ฏธ์ง€ ์ฒจ๋ถ€ ๊ฐ€๋Šฅ)

## ๋ฆฌ๋ทฐ์–ด ๋ฉ˜์…˜

- `@1๋ฒˆ`, `@2๋ฒˆ` ๊ณผ ๊ฐ™์ด ๋ถ€์—ฌํ•œ ๋ฆฌ๋ทฐ์–ด๋ฅผ ๋ฉ˜์…˜ํ•ด์ฃผ์„ธ์š”(slack ์•Œ๋ฆผ์„ ์œ„ํ•ด)

## ์Šคํฌ๋ฆฐ์ƒท (์„ ํƒ)

## ๋ฆฌ๋ทฐ ์š”๊ตฌ์‚ฌํ•ญ(์„ ํƒ)

- ๋ฆฌ๋ทฐ์–ด๊ฐ€ ํŠน๋ณ„ํžˆ ๋ด์ฃผ์—ˆ์œผ๋ฉด ํ•˜๋Š” ๋ถ€๋ถ„์ด ์žˆ๋‹ค๋ฉด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”

- ex) ๋ฉ”์„œ๋“œ XXX์˜ ์ด๋ฆ„์„ ๋” ์ž˜ ์ง“๊ณ  ์‹ถ์€๋ฐ ํ˜น์‹œ ์ข‹์€ ๋ช…์นญ์ด ์žˆ์„๊นŒ์š”?

์„ค๊ณ„

๐Ÿ“Œ ERD

image

๐Ÿ“Œ API ๋ช…์„ธ์„œ

image image

๐Ÿ“Œ ๊ฐœ๋ฐœ ์ค‘์  ์‚ฌํ•ญ

  1. ๊ธฐํš, ์œ ์ €์˜ ์ž…์žฅ์„ ์ถฉ๋ถ„ํžˆ ์ดํ•ดํ•˜๋ฉฐ ๊ฐœ๋ฐœํ•˜๊ธฐ
  2. ๋น„์šฉ, ๊ด€๋ฆฌํ•ด์•ผํ•˜๋Š” ๋ฆฌ์†Œ์Šค์˜ ์ตœ์†Œํ™”
  3. ํ…Œ์ŠคํŠธ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ๋™์ž‘ํ•˜๋Š” ์•ˆ์ •์ ์ธ ์„œ๋น„์Šค ๋ฐฐํฌ (Spring Rest Docs๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ API ๋ช…์„ธ์„œ ๊ตฌํ˜„)

๐Ÿ“Œ ์•„ํ‚คํ…์ฒ˜

์„œ๋ฒ„ ์•„ํ‚คํ…์ฒ˜

_แ„Žแ…ฌแ„Œแ…ฉแ†ผ_แ„‹แ…กแ„แ…ตแ„แ…ฆแ†จแ„Žแ…ฅ drawio (1)

๋ฐฐํฌ ์•„ํ‚คํ…์ฒ˜

แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2024-08-26 แ„‹แ…ฉแ„’แ…ฎ 2 39 01

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages