Skip to content

34th-SOPKATHON-iOS-TEAM2/SOPKATHON-SERVER

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

48 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ† ๋„ˆ ์ด๊ฑฐ ์•Œ์•„? ๐Ÿ†

๋ฌธํ•ด๋ ฅ ๋ถ€์žฌ๋ฅผ ๊ฐ€์žฅ ํŠธ๋ Œ๋””ํ•˜๊ฒŒ ์ฑ„์šฐ์ž.

์ฃผ์š” ๊ธฐ๋Šฅ

  1. ๋ฌธํ•ด๋ ฅ ํ€ด์ฆˆ: 1์ผ 5๋ฌธ์ œ ์žฌ๋ฐŒ๋Š” ๋ฌธํ•ด๋ ฅ ํ€ด์ฆˆ ํ’€๊ธฐ
  2. ํ€ด์ฆˆ ๊ณต์œ : ๋„ˆ ์ด๊ฑฐ ์•Œ์•„? ์นœ๊ตฌ์—๊ฒŒ ๊ณต์œ ํ•˜๊ธฐ
  3. ๊ธฐ๋ก: ๋‚˜์˜ ํ€ด์ฆˆ ๊ธฐ๋ก์„ ํ™•์ธํ•ด์š”!

Developers โœจ

๊น€์ฑ„์› ๊ณ ๋‚˜์—ฐ
image image

SERVER

SERVER

Role Distribution ๐ŸŽฏ

Role Developer
๋ฌธ์ œ ์ƒ์„ธ ์กฐํšŒ, ๋ฌธ์ œ ํ’€์ด, ๋ฌธ์ œ ์ƒ์„ธ ์กฐํšŒ ๊น€์ฑ„์›
๋ฉค๋ฒ„ ์ƒ์„ฑ, ๋ฌธ์ œ ์กฐํšŒ(ํ™ˆ ํ™”๋ฉด),์ฑ„์ ํ‘œ ์กฐํšŒ, ๊ธฐ๋ก ๋ฆฌ์ŠคํŠธ ์กฐํšŒ ๊ณ ๋‚˜์—ฐ

ERD ๐Ÿ—‚๏ธ

image

Foldering ๐Ÿ—‚๏ธ

image

API Specification ๐Ÿ”—

API ๋ช…์„ธ์„œ ๋ฐ”๋กœ๊ฐ€๊ธฐ

image

Code Convention ๐Ÿ”—

Code ์ปจ๋ฒค์…˜ ๋ฐ”๋กœ๊ฐ€๊ธฐ

1. ๋ธŒ๋žœ์น˜ ์ปจ๋ฒค์…˜

๋ธŒ๋žœ์น˜ ์šด์˜ ๋ฐฉ์‹

Git Flow ์ „๋žต

image

๐Ÿ’ก `main` **โ†’ ์šฐ๋ฆฐ ์ด๊ฑธ default ๋ธŒ๋žœ์น˜๋กœ!**

feat: ๊ธฐ๋Šฅ์„ ๊ฐœ๋ฐœํ•˜๋ฉด์„œ ๊ฐ์ž๊ฐ€ ์‚ฌ์šฉํ•  ๋ธŒ๋žœ์น˜

๋ธŒ๋žœ์น˜๋ช…์€ โ€œfeat/#์ด์Šˆ ๋ฒˆํ˜ธโ€ ํ˜•์‹

์˜ˆ์‹œ: feat/#3

2. ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

  • [FEAT] : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„
  • [CHORE] : ๋™์ž‘์— ์˜ํ–ฅ ์—†๋Š” ์ฝ”๋“œ or ๋ณ€๊ฒฝ ์—†๋Š” ๋ณ€๊ฒฝ ์‚ฌํ•ญ(์ฃผ์„ ์ถ”๊ฐ€ ๋“ฑ)
  • [ADD] : Feat ์ด์™ธ์˜ ๋ถ€์ˆ˜์ ์ธ ์ฝ”๋“œ ์ถ”๊ฐ€, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์ถ”๊ฐ€, ์ƒˆ๋กœ์šด ํŒŒ์ผ ์ƒ์„ฑ
  • [DEL] : ์“ธ๋ชจ ์—†๋Š” ์ฝ”๋“œ ์‚ญ์ œ
  • [RENAME] : ํŒŒ์ผ ๋ช…, ๋ณ€์ˆ˜ ๋ช… ์ˆ˜์ •
  • [FIX] : ์ฝ”๋“œ ์ˆ˜์ •, ๋ฒ„๊ทธ/์˜ค๋ฅ˜ ํ•ด๊ฒฐ
  • [DOCS] : README๋‚˜ WIKI ๋“ฑ์˜ ๋ฌธ์„œ ์ˆ˜์ •
  • [DEPLOY]: ๋ฐฐํฌ ๊ด€๋ จ
  • [REFACTOR] : ์ „๋ฉด ์ˆ˜์ •, ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
  • [MERGE]: ๋‹ค๋ฅธ ๋ธŒ๋žœ์น˜์™€ ๋ณ‘ํ•ฉ
  • [TEST]: ํ…Œ์ŠคํŠธ ์ถ”๊ฐ€/์ˆ˜์ •
  • [HOTFIX] : ๊ธ‰ํ•œ ํ•ซํ”ฝ์Šค

์ปค๋ฐ‹ ๋‹จ์œ„

  • ์„ธ๋ถ€ ๊ธฐ๋Šฅ ๊ธฐ์ค€

์ปค๋ฐ‹ ์˜ˆ์‹œ

[FEAT] #์ด์Šˆ๋ฒˆํ˜ธ ๋‚ด์šฉ

ex ) git commit -m "[FEAT] #2 ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ๊ตฌํ˜„"

3. ์ด์Šˆ & PR ์ปจ๋ฒค์…˜

์ด์Šˆ/PR ์ƒ์„ฑ ์‹œ ์ œ๋ชฉ ํ˜•์‹

[FEAT] ๊ตฌํ˜„ํ•œ ๋‚ด์šฉ

์˜ˆ์‹œ : [FEAT] ํ™ˆ ํ™”๋ฉด ์ฆ๊ฒจ์ฐพ๊ธฐ API ๊ตฌํ˜„

โ—์ด์Šˆ ํ…œํ”Œ๋ฆฟ

<!--- 
โ—๏ธ ์ด์Šˆ ์ œ๋ชฉ์€ ์•„๋ž˜์˜ ํ˜•์‹์„ ๋งž์ถฐ์ฃผ์„ธ์š” 
- [FEAT] ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- [FIX] ์—๋Ÿฌ ์ˆ˜์ •, ๋ฒ„๊ทธ ์ˆ˜์ •
- [CHORE] gradle ์„ธํŒ…, ์œ„์˜ ๊ฒƒ ์ด์™ธ์— ๊ฑฐ์˜ ๋ชจ๋“  ๊ฒƒ
- [DOCS] README, ๋ฌธ์„œ
- [REFACTOR] ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง (๊ธฐ๋Šฅ ๋ณ€๊ฒฝ ์—†์ด ์ฝ”๋“œ๋งŒ ์ˆ˜์ •ํ•  ๋•Œ)
- [MODIFY] ์ฝ”๋“œ ์ˆ˜์ • (๊ธฐ๋Šฅ์˜ ๋ณ€ํ™”๊ฐ€ ์žˆ์„ ๋•Œ)
-->

## โœจ ์ด์Šˆ ๋‚ด์šฉ

-

## โœ… ์ฒดํฌ๋ฆฌ์ŠคํŠธ

- [ ] Assignees / Labels ์„ ํƒ
- [ ] 
- [ ]

โ—PR ํ…œํ”Œ๋ฆฟ

<!-- - 
โ—๏ธ PR ์ œ๋ชฉ์€ ์•„๋ž˜์˜ ํ˜•์‹์„ ๋งž์ถฐ์ฃผ์„ธ์š” 
- [FEAT] ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- [FIX] ์—๋Ÿฌ ์ˆ˜์ •, ๋ฒ„๊ทธ ์ˆ˜์ •
- [CHORE] gradle ์„ธํŒ…, ์œ„์˜ ๊ฒƒ ์ด์™ธ์— ๊ฑฐ์˜ ๋ชจ๋“  ๊ฒƒ
- [DOCS] README, ๋ฌธ์„œ
- [REFACTOR] ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง (๊ธฐ๋Šฅ ๋ณ€๊ฒฝ ์—†์ด ์ฝ”๋“œ๋งŒ ์ˆ˜์ •ํ•  ๋•Œ)
- [MODIFY] ์ฝ”๋“œ ์ˆ˜์ • (๊ธฐ๋Šฅ์˜ ๋ณ€ํ™”๊ฐ€ ์žˆ์„ ๋•Œ)
-->

## ๐Ÿ“Œ ๊ด€๋ จ ์ด์Šˆ
<!-- ๊ด€๋ จ์žˆ๋Š” ์ด์Šˆ ๋ฒˆํ˜ธ(#000)์„ ์ ์–ด์ฃผ์„ธ์š”.
  ํ•ด๋‹น pull request merge์™€ ํ•จ๊ป˜ ์ด์Šˆ๋ฅผ ๋‹ซ์œผ๋ ค๋ฉด
  closed #Issue_number๋ฅผ ์ ์–ด์ฃผ์„ธ์š” -->

## โœจ ์–ด๋–ค ์ด์œ ๋กœ ๋ณ€๊ฒฝ๋œ ๋‚ด์šฉ์ธ์ง€
<!-- ์–ด๋–ค ๊ธฐ๋Šฅ์„ ๋งŒ๋“ค๊ธฐ ์œ„ํ•œ ๋‚ด์šฉ์ธ์ง€ ์ ์–ด์ฃผ์„ธ์š” -->
<!โ€” ๊ทธ๊ฒŒ ์•„๋‹Œ ๊ฒฝ์šฐ์—๋Š” ์–ด๋–ค ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ ๊ฒƒ์ธ์ง€ ์ ์–ด์ฃผ์„ธ์š” โ€”>

## ๐Ÿ™ ๊ฒ€ํ†  ํ˜น์€ ๋ฆฌ๋ทฐ์–ด์—๊ฒŒ ๋‚จ๊ธฐ๊ณ  ์‹ถ์€ ๋ง
<!โ€” Reviewers, Assignees, Labels ์ง€์ •ํ•ด์ฃผ์„ธ์š” โ€”>

image

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages