Skip to content

Latest commit

ย 

History

History
91 lines (69 loc) ยท 2.98 KB

README.md

File metadata and controls

91 lines (69 loc) ยท 2.98 KB

app-debug.apk.zip

๐Ÿ• ConnectDog, ์ฝ”๋„ฅ๋…

๐Ÿ–ฅ Development

Required

  • IDE : Android Studio Giraffe (Download)
  • JDK : Java 17 (jbr-17 ์‚ฌ์šฉ)
  • Kotlin Language : 1.8.2

Language

  • Kotlin

Libraries

  • AndroidX

    • Activity & Activity Compose
    • AppCompat
    • Core
    • Lifecycle & ViewModel Compose
    • Navigation
  • Kotlin Libraries (Coroutine, DateTime, Serialization)

  • Compose

    • Material3
    • Navigation
  • Landscapist & Landscapist Coil

  • Dagger & Hilt

  • Square (Retrofit2, OkHttp3)

Gradle Dependency

Gradle Version Catalog ๋ฅผ ํ™œ์šฉํ•˜์—ฌ ์ข…์†์„ฑ๊ณผ ํ”Œ๋Ÿฌ๊ทธ์ธ์„ ๊ด€๋ฆฌํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.

์ž์„ธํ•œ ๋‚ด์šฉ์€ libs.versions.toml ๋ฅผ ์ฐธ๊ณ ํ•ด ์ฃผ์„ธ์š”.

๐Ÿงฉ Architecture

Module Dependency Graph

๋ณธ ํ”„๋กœ์ ํŠธ๋Š” Multi-module ๊ตฌ์กฐ์ด๋ฉฐ ๊ฐ Feature๋งˆ๋‹ค ๋ชจ๋“ˆ ํ˜•ํƒœ๋กœ ๊ตฌ์„ฑ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿค ํ˜‘์—… ๊ทœ์น™

Coding Convention & Tool

Commit Convention

Type Description
feat ์‹ ๊ทœ ๊ธฐ๋Šฅ ๊ตฌํ˜„ ์ž‘์—… (UI ๊ตฌํ˜„ ํฌํ•จ)
style ์ด๋ฏธ์ง€, ํฐํŠธ ๋“ฑ values์— ์ถ”๊ฐ€ํ•  ๋•Œ
update ํŒŒ์ผ ์ฝ”๋“œ ์ˆ˜์ •, ๋ฆฌํŒฉํ† ๋ง ์ž‘์—…
delete ํŒŒ์ผ ์‚ญ์ œ
docs ๋ฌธ์„œ ๊ด€๋ จ ์ž‘์—…
fix ๋ฒ„๊ทธ ์ˆ˜์ •
rename ๋ณ€์ˆ˜/ํด๋ž˜์Šค/๋ฉ”์„œ๋“œ ๋ช… ๋ณ€๊ฒฝ
build dependencies ๋ณ€๊ฒฝ
chore configs ๋ณ€ํ™” ๋“ฑ ๊ทธ ์™ธ ์ž‘์—… (์ฝ”๋“œ ๋ณ€๊ฒฝ X)

Branch Strategy

์ž‘์—… ์ˆœ์„œ

  1. ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ์ „ Issue ์ƒ์„ฑ
  2. Issue ํŽ˜์ด์ง€์—์„œ ์ƒˆ branch ์ƒ์„ฑ
  3. local์—์„œ ์ž‘์—… ํ›„ ํ•ด๋‹น branch๋กœ PR ์˜ฌ๋ฆฌ๊ธฐ
  4. PR์— ๋Œ€ํ•œ ๋ฆฌ๋ทฐ๋กœ ๋ชจ๋‘์—๊ฒŒ approve ๋˜๋ฉด
  5. PR ์˜ฌ๋ฆฐ ๋‹น์‚ฌ์ž๊ฐ€ develop์— merge
    • ํ•„์š”์—†์„ ์‹œ ํ•ด๋‹น branch ์‚ญ์ œ
    • PR์€ ํ•ญ์ƒ FIFO ์ˆœ์„œ๋Œ€๋กœ merge

Git flow

  • main : ์ถœ์‹œ ์ค€๋น„ ์™„๋ฃŒ๋œ branch
  • develop : ๋‹ค์Œ ์ถœ์‹œ ๋ฒ„์ „์„ ๊ฐœ๋ฐœํ•˜๋Š” branch
  • feature/** : ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์„ ์œ„ํ•œ branch
    • ์˜ˆ์‹œ: feature/member-api
  • release : ์ถœ์‹œ ์ „ QA๋ฅผ ์œ„ํ•œ branch
  • hotfix/** : ์ถœ์‹œ๋œ ๋ฒ„์ „์˜ ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •ํ•˜๋Š” branch
    • ์˜ˆ์‹œ: hotfix/login