OZ-Coding-School / oz_02_collabo-003-BE

oz_02_collabo-003-BE
3 stars 1 forks source link

K์ฒ ํ•™๊ด€



๐Ÿ’ซ์˜ค๋Š˜์˜ ํž˜์ด ๋˜๋Š” ํ•œ๋งˆ๋””, ๋ ๋ณ„ ์šด์„ธ, ๋ณ„์ž๋ฆฌ๋ณ„ ์šด์„ธ, MBTI๋ณ„ ์šด์„ธ๋ฅผ ์ œ๊ณตํ•ด์ค๋‹ˆ๋‹ค๐Ÿ’ซ

๐Ÿ–ผ๏ธWire Frame๐Ÿ–ผ๏ธ

- (4/16) : OZ 2๊ธฐ 3์กฐ ํ•ฉ๋™ ํ”„๋กœ์ ํŠธ ์‹œ์ž‘.
- (4/23) : ์†Œ์…œ ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ์‚ญ์ œ.

๐Ÿง‘๐Ÿปโ€๐Ÿง‘๐Ÿปโ€๐Ÿง’๐ŸปํŒ€์› ์†Œ๊ฐœ

์‹ ํ˜„๋ฏผ ํ”„๋กœํ•„
ํŒ€์žฅ / BE ํŒ€์žฅ : ์‹ ํ˜„๋ฏผ

๊น€๋ฏผ์ • ํ”„๋กœํ•„
BE ํŒ€์› : ๊น€๋ฏผ์ •

ํ™ฉ์ฃผํœ˜ ํ”„๋กœํ•„
BE ํŒ€์› : ํ™ฉ์ฃผํœ˜

๊น€๋ฒ”์ˆ˜ ํ”„๋กœํ•„
FE ํŒ€์žฅ : ๊น€๋ฒ”์ˆ˜

๊น€์„ ํฌ ํ”„๋กœํ•„
FE ํŒ€์› : ๊น€์„ ํฌ

๋ฐฐํ•˜์—ฐ ํ”„๋กœํ•„
FE ํŒ€์› : ๋ฐฐํ•˜์—ฐ


BD ํŒ€์žฅ : ๊น€ํšจ์ง„


BD ํŒ€์› : ๊น€๊ตญํ™”


BD ํŒ€์› : ๊น€ํ˜„ํ•„



โš™๏ธ๊ธฐ์ˆ  ์Šคํƒ

โœ…Frond-end


โœ…Back-end


๐Ÿ’ฌCommunication Tools


๐Ÿ“นVideo Conference Tools


๐Ÿ–ฅ๏ธ ํ”„๋กœ์ ํŠธ ๊ทœ์น™

Branch Strategy

  • main / dev ๋ธŒ๋žœ์น˜ ๊ธฐ๋ณธ ์ƒ์„ฑ
  • main๊ณผ dev๋กœ ์ง์ ‘ push ์ œํ•œ
  • PR ์ „ ์ตœ์†Œ 1์ธ ์ด์ƒ ์Šน์ธ ํ•„์ˆ˜
  • Branch ๋ช…๋ช…๊ทœ์น™
  • |Feat :|์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„|
    |Add :|์—์…‹ ํŒŒ์ผ ์ถ”๊ฐ€|
    |Fix :|๋ฒ„๊ทธ ์ˆ˜์ •|
    |Docs :|๋ฌธ์„œ ์ถ”๊ฐ€ ๋ฐ ์ˆ˜์ •|
    |Style :|์Šคํƒ€์ผ๋ง ์ž‘์—…|
    |Refactor :|์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง (๋™์ž‘ ๋ณ€๊ฒฝ ์—†์Œ)|
    |Test :|ํ…Œ์ŠคํŠธ|
    |Conf :|๋นŒ๋“œ, ํ™˜๊ฒฝ ์„ค์ •|
    |Chore :|๊ธฐํƒ€ ์ž‘์—…|
    ํŠน์ˆ˜ ๋ฌธ์ž ์ œํ•œ: ์Šฌ๋ž˜์‹œ(/), ๋ฐฑ์Šฌ๋ž˜์‹œ(), ์ŠคํŽ˜์ด์Šค( ), ์ฝœ๋ก (:), ์•ต๊ธ€ ๋ธŒ๋ž˜ํ‚ท(< >), ์ฟผํŠธ("), ํŒŒ์ดํ”„(|), ๋ฌผ์Œํ‘œ(?), ๋ณ„ํ‘œ(*), ๋Š๋‚Œํ‘œ(!)
    ๊ธธ์ด์™€ ๋ฌธ์ž: ASCII ๋ฌธ์ž๋งŒ ์‚ฌ์šฉ, ๋Œ€์†Œ๋ฌธ์ž๋ฅผ ๊ตฌ๋ถ„. ์ด๋ฆ„์€ ๊ฐ„๊ฒฐํ•˜๋ฉด์„œ๋„ ํ•ด๋‹น ๋ธŒ๋žœ์น˜์˜ ๋ชฉ์ ์ด๋‚˜ ๊ธฐ๋Šฅ์„ ๋ช…ํ™•ํžˆ ์„ค๋ช…ํ•  ์ˆ˜ ์žˆ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
    ๊ธฐํ˜ธ ์‚ฌ์šฉ: ํ•˜์ดํ”ˆ(-), ์–ธ๋”์Šค์ฝ”์–ด(_), ์ˆซ์ž๋กœ ์‹œ์ž‘ํ•˜๊ฑฐ๋‚˜ ์ข…๋ฃŒํ•  ์ˆ˜ ์—†์œผ๋ฉฐ, ์—ฐ์†์ ์ธ ๋งˆ์นจํ‘œ(..)๋ฅผ ํฌํ•จํ•˜๊ฑฐ๋‚˜ @{} ํ˜•์‹์„ ํฌํ•จํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.
    ์˜ˆ์•ฝ์–ด ํ”ผํ•˜๊ธฐ: ํŠน์ • ๋‹จ์–ด์™€ ํ˜•์‹์€ Git์—์„œ ์˜ˆ์•ฝ๋˜์–ด ์žˆ์œผ๋ฏ€๋กœ ๋ธŒ๋žœ์น˜ ์ด๋ฆ„์œผ๋กœ ์‚ฌ์šฉ์„ ํ”ผํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
    ์˜ˆ๋ฅผ ๋“ค์–ด, HEAD, FETCH_HEAD, ORIG_HEAD, MERGE_HEAD ๋“ฑ์€ ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.
    ์ž‘์„ฑ ์˜ˆ์‹œ: feat_BE-LUCK401

Git Convention

  1. ์ ์ ˆํ•œ ์ปค๋ฐ‹ ์ ‘๋‘์‚ฌ ์ž‘์„ฑ
  2. ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ๋‚ด์šฉ ์ž‘์„ฑ
  3. ๋‚ด์šฉ ๋’ค์— ์ด์Šˆ (#์ด์Šˆ ๋ฒˆํ˜ธ)์™€ ๊ฐ™์ด ์ž‘์„ฑํ•˜์—ฌ ์ด์Šˆ ์—ฐ๊ฒฐ ์ ‘๋‘์‚ฌ ์„ค๋ช…
    Feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„
    Add : ์—์…‹ ํŒŒ์ผ ์ถ”๊ฐ€
    Fix : ๋ฒ„๊ทธ ์ˆ˜์ •
    Docs : ๋ฌธ์„œ ์ถ”๊ฐ€ ๋ฐ ์ˆ˜์ •
    Style : ์Šคํƒ€์ผ๋ง ์ž‘์—…
    Refactor : ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง (๋™์ž‘ ๋ณ€๊ฒฝ ์—†์Œ)
    Test : ํ…Œ์ŠคํŠธ
    Deploy : ๋ฐฐํฌ
    Conf : ๋นŒ๋“œ, ํ™˜๊ฒฝ ์„ค์ •
    Chore : ๊ธฐํƒ€ ์ž‘์—…

Pull Request

Title

  • ์ œ๋ชฉ์€ '[Feat] ํ™ˆ ํŽ˜์ด์ง€ ๊ตฌํ˜„'๊ณผ ๊ฐ™์ด ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.

PR Type

FEAT: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„ ADD : ์—์…‹ ํŒŒ์ผ ์ถ”๊ฐ€ FIX: ๋ฒ„๊ทธ ์ˆ˜์ • DOCS: ๋ฌธ์„œ ์ถ”๊ฐ€ ๋ฐ ์ˆ˜์ • STYLE: ํฌ๋งทํŒ… ๋ณ€๊ฒฝ REFACTOR: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง TEST: ํ…Œ์ŠคํŠธ ๊ด€๋ จ DEPLOY: ๋ฐฐํฌ ๊ด€๋ จ CONF: ๋นŒ๋“œ, ํ™˜๊ฒฝ ์„ค์ • CHORE: ๊ธฐํƒ€ ์ž‘์—…

Description

  • ๊ตฌ์ฒด์ ์ธ ์ž‘์—… ๋‚ด์šฉ์„ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.
  • ์ด๋ฏธ์ง€๋ฅผ ๋ณ„๋„๋กœ ์ฒจ๋ถ€ํ•˜๋ฉด ๋” ์ข‹์Šต๋‹ˆ๋‹ค ๐Ÿ‘

Discussion

  • ์ถ”ํ›„ ๋…ผ์˜ํ•  ์ ์— ๋Œ€ํ•ด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

Code Convention

BE

  • ํŒจํ‚ค์ง€๋ช… ์ „์ฒด ์†Œ๋ฌธ์ž
  • ํด๋ž˜์Šค๋ช…, ์ธํ„ฐํŽ˜์ด์Šค๋ช… CamelCase
  • ํด๋ž˜์Šค ์ด๋ฆ„ ๋ช…์‚ฌ ์‚ฌ์šฉ
  • ์ƒ์ˆ˜๋ช… SNAKE_CASE
  • Controller, Service, Dto, Repository, mapper ์•ž์— ์ ‘๋ฏธ์‚ฌ๋กœ ํ†ต์ผ(ex. MemberController)
  • service ๊ณ„์ธต ๋ฉ”์„œ๋“œ๋ช… create, update, find, delete๋กœ CRUD ํ†ต์ผ(ex. createMember)
  • Test ํด๋ž˜์Šค๋Š” ์ ‘๋ฏธ์‚ฌ๋กœ Test ์‚ฌ์šฉ(ex. memberFindTest)

FE

  • ..

Communication Rules

  • ์ •๊ธฐ ํšŒ์˜ : ํ™”, ๋ชฉ ์˜ค์ „ 11์‹œ ํŒ€์žฅ ํšŒ์˜
  • ํŒ€ ํšŒ์˜ : ๊ฐ ํŒ€๋ณ„ ๋ณ„๋„ ์ง„ํ–‰
  • ์ „์ฒด ํšŒ์˜ : ๊ธฐ์—… ๊ด€๋ฆฌ์ž์™€ ํšŒ์˜ (Slack ์ด์šฉ)

๐Ÿ—‚๏ธDocuments

๐Ÿ“œNotion K์ฒ ํ•™๊ด€
๐Ÿ“œํŒ€ ๊ทœ์น™
๐Ÿ“œ์‚ฌ์šฉ์ž ์š”๊ตฌ์‚ฌํ•ญ ์ •์˜์„œ
๐Ÿ“œํ…Œ์ด๋ธ” ๋ช…์„ธ์„œ
๐Ÿ“œERD
๐Ÿ“œAPI ๋ช…์„ธ์„œ
๐Ÿ“œํ™”๋ฉด ์ •์˜์„œ