Skip to content

Latest commit

ย 

History

History
168 lines (123 loc) ยท 6.33 KB

README.md

File metadata and controls

168 lines (123 loc) ยท 6.33 KB

pengdolli-team11-mobile

์ˆ˜์ƒ

  • ๐Ÿ…GDSC ์—ฐํ•ฉ ํ•ด์ปคํ†ค: ๋ˆˆ๊ฝƒํ†ค ์ตœ์šฐ์ˆ˜์ƒ

ํŒ€์›

์•ˆ๋“œ๋กœ์ด๋“œ

์œ ์ง„ ๋ฐ•์ •๋ฏผ ํ™ฉ์„œ์•„
ํˆฌํ‘œํ•˜๊ธฐ ๋ชจ์•„๋ณด๊ธฐ ์ƒ์„ธ๋ณด๊ธฐ ํ™ˆ 3D ๋ฆฌ์†Œ์Šค ์ œ์ž‘ ์นด์นด์˜ค๋กœ๊ทธ์ธ

๋ฐฑ์—”๋“œ

๊ฐ•์Šน์ค€ ์ž„ํ˜•๊ทœ

์„œ๋น„์Šค ์†Œ๊ฐœ

  • ํŽญ๋„๋ฆฌ : ๊ธฐ์˜จ์— ๋”ฐ๋ฅธ ๊ฒจ์šธ์ฒ  ์‹ค์‹œ๊ฐ„ ์˜ท์ฐจ๋ฆผ ์ถ”์ฒœ ์„œ๋น„์Šค

์‹œ์—ฐ

device-2024-01-13-054417.1.mp4

๋ฐœํ‘œ์ž๋ฃŒ

แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-01 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-02 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-03 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-04 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-05 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-06 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-07 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-08 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-09 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-10 แ„‚แ…ฎแ†ซแ„แ…ฉแ†พแ„แ…ฉแ†ซ 11แ„แ…ตแ†ท-11

Convention

Commit Message Convention

์ปค๋ฐ‹ํƒœ๊ทธ: ๋‚ด์šฉ #์ด์Šˆ๋ฒˆํ˜ธ

ex. add: login ํŒŒ์ผ ์ถ”๊ฐ€ #20

  • ํŒŒ์ผ ์ถ”๊ฐ€ : add
  • ๋ฒ„๊ทธ ์ˆ˜์ • : fix
  • ๋ฆฌํŒฉํ„ฐ๋ง : refactoring
  • ํŒŒ์ผ ์‚ญ์ œ : remove
  • ๊ธฐ๋Šฅ ์ถ”๊ฐ€ : feat
  • ๋ฌธ์„œ ์ˆ˜์ • : docs
  • ์ฃผ์„ ์ถ”๊ฐ€ : comment

Git convention

  1. Github Flow
  2. ์ž‘์€ ๊ธฐ๋Šฅ ํ•˜๋‚˜ ๊ตฌํ˜„ ํ•  ๋•Œ ๋งˆ๋‹ค ์ปค๋ฐ‹ํ•˜๊ธฐ
  3. issue๋Š” ํฐ ๊ธฐ๋Šฅ์ด๋‚˜ ํ•œ ํ™”๋ฉด ๊ธฐ์ค€์œผ๋กœ ํฐ ๋‹จ์œ„์˜ ์ž‘์—…
  4. PR์€ ์ž‘์—… ๋ถ„๋Ÿ‰์œผ๋กœ ์ •์ƒ์ž‘๋™ ๋‚ด์šฉ์ด ์žˆ๋‹ค๋ฉด ๋จธ์ง€ํ•˜๋Š” ์‹์œผ๋กœ ์ž‘์€ ๋‹จ์œ„์˜ ์ž‘์—…
  5. ์ปค๋ฐ‹ ํ•˜๋‚˜๋ผ๋„ ํ–ˆ์œผ๋ฉด PR ๋ฐ”๋กœ ํ•˜๊ธฐ
  6. ๊นƒํ—™ ํ”Œ๋กœ์šฐ์˜ ์ƒ๋ช…์€ ๋น ๋ฅธ merge (์ž‘์€ ๊ตฌํ˜„ ๋‹จ์œ„๋กœ PR์„ ๋Š์์‹œ๋‹ค!)
    ํ•œ PR์—์„œ ๋ชจ๋“ ๊ฑธ ๋‹ค ํ•˜๋ ค๊ณ  ํ•˜์ง€ ๋ง์•„์š”

Branch Convention

{์ž‘์—…์œ ํ˜•}/#{์ด์Šˆ ๋ฒˆํ˜ธ} ex) feat/#3, fix/#4 ...

๋ธŒ๋žœ์น˜๋ฅผ ์ƒˆ๋กœ ์ƒ์„ฑํ•  ๋•Œ์—๋Š” ๊ผญ ์ตœ์‹  ๋ฒ„์ „์˜ main ๋ธŒ๋žœ์น˜๋ฅผ ๊ธฐ์ ์œผ๋กœ ์ƒ์„ฑํ•˜๊ธฐ

Commit Message Convention

{์ž‘์—…์œ ํ˜•}: {์ž‘์—…๋‚ด์šฉ} ex) add: login ํŒŒ์ผ ์ถ”๊ฐ€

  • ํŒŒ์ผ ์ถ”๊ฐ€ : add
  • ๋ฒ„๊ทธ ์ˆ˜์ • : fix
  • ๋ฆฌํŒฉํ„ฐ๋ง : refactoring
  • ํŒŒ์ผ ์‚ญ์ œ : remove
  • ๊ธฐ๋Šฅ ์ถ”๊ฐ€ : feat
  • ๋ฌธ์„œ ์ˆ˜์ • : docs
  • ์ฃผ์„ ์ถ”๊ฐ€ : comment

์ž‘์€ ๊ธฐ๋Šฅ ํ•˜๋‚˜ ๊ตฌํ˜„ ํ•  ๋•Œ ๋งˆ๋‹ค ์ปค๋ฐ‹ํ•˜๊ธฐ

ISSUE Convention

[{์ž‘์—…์œ ํ˜•}] {์ž‘์—…๋‚ด์šฉ} ex) [Feat] ๋ฆฌ๋ทฐ ๋ชฉ๋ก

PR Convention

[{์ž‘์—…์œ ํ˜•}/#{์ด์Šˆ๋ฒˆํ˜ธ}] ์ž‘์—…๋‚ด์šฉ ex) [Feat/#3] ๋ฆฌ๋ทฐ ์“ฐ๊ธฐ ๊ตฌํ˜„ ์™„๋ฃŒ

๋ฉ”์ธ์— ์žˆ๋Š” ๋‚ด์šฉ ๋จธ์ง€ํ•˜๊ธฐ๏ผˆ๋‚ด ๋ธŒ๋žœ์น˜ ์ตœ์‹ ํ™”ํ•˜๊ธฐ๏ผ‰

๐Ÿ’ก ํŒ€์› A ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ main ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ–ˆ๋‹ค. ์ด๋Š” main ๋ธŒ๋žœ์น˜์— ๋“ค์–ด๊ฐ„๊ฒƒ์ด๊ธฐ์—, ํ˜„์žฌ ๋‚ด๊ฐ€ ์ž‘์—…ํ•˜๋Š” B๋ธŒ๋žœ์น˜์—๋Š” ๋‚ด์šฉ์ด ์กด์žฌํ•˜์ง€๋Š” ์•Š๋Š”๋‹ค.
๊ทธ๋ ‡๋‹ค๋ฉด ๋‚ด๊ฐ€ ์ง€๊ธˆ ์ž‘์—…ํ•˜๊ณ  ์žˆ๋Š” B ๋ธŒ๋žœ์น˜์—์„œ ํŒ€์› A๊ฐ€ main์— ๋จธ์ง€ํ•œ ๋‚ด์šฉ์„ ๊ฐ€์ ธ์˜ค๊ณ  ์‹ถ๋‹ค๋ฉด ์–ด๋–ป๊ฒŒ ํ•ด์•ผํ• ๊นŒ?

git checkout main  
git pull //๋จผ์ € ๋กœ์ปฌ์˜ ๋ฉ”์ธ ๋ธŒ๋žœ์น˜๋ฅผ ์ตœ์‹ ํ™” ํ•ด์ค€๋‹ค.

git checkout B  
git merge main //b ๋ธŒ๋žœ์น˜์— main ๋‚ด์šฉ ๋„ฃ๊ธฐ

Android convention

layout id ๊ทœ์น™

@+id/tv_login
@+id/et_password
@+id/btn_login

view ์ด๋ฆ„

  • TextView -> tv_
  • ImageView -> iv_
  • EditText -> et_
  • Button, ImageButton -> btn_
  • ConstraintLayout -> cl_
  • LinearLayout -> ll_
  • BottonNavitaionView -> bnv_

layout ํŒŒ์ผ๋ช…

snake_case๋ฅผ ์ ์šฉํ•œ๋‹ค.

  • activity_๊ธฐ๋Šฅ: activity_login
  • fragment_๊ธฐ๋Šฅ: fragment_home
  • item_๊ธฐ๋Šฅ: item_user

drawable ํŒŒ์ผ๋ช…

์—ญ์‹œ xml ์ด๊ธฐ ๋•Œ๋ฌธ์— snake_case๋ฅผ ์ ์šฉํ•œ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ ์•„๋ž˜๋ฅผ ์ฐธ๊ณ ํ•œ๋‹ค.

  • icon์€ โ€œic_โ€ -> ic_error
  • image๋Š” โ€œimg_โ€ -> img_default_user
  • shape๋Š” โ€œshape_โ€ -> shape_border_radius10
  • selector๋Š” โ€œselector_โ€ -> selector_edittext_background

์•„์ด์ฝ˜ ์ด๋ฆ„ ๊ทœ์น™

ic_๊ธฐ๋Šฅ_๋ชจ์–‘

  1. ํ™”์‚ดํ‘œ ๊ฐ™์€ ๊ฒฝ์šฐ๋Š” ic_arrow_๋ฐฉํ–ฅ -> ic_back, ic_like
  2. ์„ ํƒ ์—ฌ๋ถ€๊ฐ€ ์žˆ๋Š” ์•„์ด์ฝ˜์€ ic_๊ธฐ๋Šฅ_๋ชจ์–‘๊ณผ ic_๊ธฐ๋Šฅ_๋ชจ์–‘_selected ๋กœ ๊ตฌ๋ถ„
  3. ์ƒ‰์€ ์•ˆ๋„ฃ์–ด๋„ ๋  ๊ฑฐ ๊ฐ™์Šต๋‹ˆ๋‹ค ์™œ๋ƒ ์ฝ”๋“œ์—์„œ tint๋กœ ๋ณ€๊ฒฝ ๊ฐ€๋Šฅ ๊ฐ์ž ๋ณ€๊ฒฝํ•ด์„œ ์“ฐ๊ธฐ ....

ํด๋ž˜์Šค ํŒŒ์ผ๋ช…

UpperCamelCase ์ ์šฉ ํ•˜๊ธฐ MainActivity.kt, UserViewModel.kt, WriteFragment.kt, UserInfo.kt

ํ•จ์ˆ˜๋ช…

๋™์‚ฌํ˜•ํƒœ๋กœ ์ž‘์„ฑํ•˜๊ณ , lowerCamelCase ์ ์šฉํ•˜๊ธฐ
fun showList(), fun updateContacts()

๋ณ€์ˆ˜๋ช…

๋ช…์‚ฌํ˜•ํƒœ๋กœ ์ž‘์„ฑํ•˜๊ณ , lowerCamelCase ์ ์šฉ
isEnd(Boolean ํƒ€์ž… ์ œ์™ธ), viewPagerAdapter

๋”๋ฏธ๋ฐ์ดํ„ฐ ์ด๋ฆ„ ๊ทœ์น™

recyclerview ์ด๋ฆ„_์ˆซ์ž -> post_1, post_2

์ฝ”๋“œ ์ฃผ์„ ๊ทœ์น™ (kt ํŒŒ์ผ์— ์‚ฌ์šฉ)

  1. ์ฝ”๋“œ ์œ„์— ์–ด๋–ค ๊ธฐ๋Šฅ์ธ์ง€ ์„ค๋ช… ex) ํŒŒ์ด์–ด๋ฒ ์ด์Šค ์—ฐ๊ฒฐ, ์ข‹์•„์š” ๊ธฐ๋Šฅ
  2. ๊ณตํ†ต์ ์œผ๋กœ ์‚ฌ์šฉํ•˜๋Š” ๋ณ€์ˆ˜๋ฅผ ์ œ์™ธํ•œ ์• ๋“ค์€ ์„ ์–ธ ์˜†์— // ์ด ์ฃผ์„์„ ์‚ฌ์šฉํ•ด์„œ ์„ค๋ช…ํ•ด์ฃผ๊ธฐ
  3. ํ™”๋ฉด ์ „ํ™˜ ์‹œ ์–ด๋Š ํ™”๋ฉด์—์„œ ์–ด๋Š ํ™”๋ฉด์œผ๋กœ ๋„˜์–ด๊ฐ€๋Š”์ง€ ์„ค๋ช…
  4. ์ž์„ธํ•˜๊ฒŒ ์จ์ฃผ๊ธฐ