Skip to content
/ iOS Public

๐Ÿฝ๏ธ EAT-SSU: ์ˆญ์‹ค๋Œ€ ํ•™์‹ ๋ฆฌ๋ทฐ ์•ฑ ๐Ÿฝ๏ธ iOS ๋ ˆํฌ์ง€ํ† ๋ฆฌ

Notifications You must be signed in to change notification settings

EAT-SSU/iOS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

EATSSU iOS APP

"์ˆญ์‹ค๋Œ€์—์„œ ๋จน์ž!" ์ˆญ์‹ค๋Œ€ํ•™๊ต ํ•™์‹ ๋ฆฌ๋ทฐ iOS ์•ฑ

Issue Title

[Commit Type] ์ด์Šˆ ์ œ๋ชฉ

Commit Type

issueํƒญ์˜ label๊ณผ ๋™์ผ

Setting ํ”„๋กœ์ ํŠธ ์„ธํŒ…, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์„ค์น˜

Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„ (new feature)

Add ํŒŒ์ผ ์ถ”๊ฐ€

Fix ๋ฒ„๊ทธ ์ˆ˜์ • (bug fix)

Docs ๋ฌธ์„œ ์ž‘์„ฑ, ์ˆ˜์ • (documentation)

Refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง (refactoring)

Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€

Chore ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ํŒŒ์ผ ์ด๋™ ๋ฐ ์ด๋ฆ„ ๋ณ€๊ฒฝ ๋“ฑ (production code ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ)

Commit Message Conventions

[#์ด์Šˆ๋ฒˆํ˜ธ] ์ปค๋ฐ‹๋ฉ”์‹œ์ง€
### Description
- [#1] Project Setting
- [#2] Add AlermBar

Branch Title Conventions

Commit Type / issue number

Code Convention**

1. ๋„ค์ด๋ฐ

  • ํ•จ์ˆ˜, ๋ฉ”์„œ๋“œ :ย lowerCamelCaseย ์‚ฌ์šฉํ•˜๊ณ , ๋™์‚ฌ๋กœ ์‹œ์ž‘ํ•œ๋‹ค.
  • ๋ณ€์ˆ˜, ์ƒ์ˆ˜ :ย lowerCamelCaseย ์‚ฌ์šฉํ•œ๋‹ค.
  • ์•ฝ์–ด
    • ์•ฝ์–ด๋กœ ์‹œ์ž‘ํ•˜๋Š” ๊ฒฝ์šฐ: ์†Œ๋ฌธ์ž๋กœ ํ‘œ๊ธฐ
    • ๊ทธ ์™ธ์˜ ๊ฒฝ์šฐ์—๋Š” ์•ฝ์–ด๋ฅผ ํ•ญ์ƒ ๋Œ€๋ฌธ์ž๋กœ ํ‘œ๊ธฐํ•ฉ๋‹ˆ๋‹ค
  • ํด๋ž˜์Šค, ๊ตฌ์กฐ์ฒด, enum, extension ๋“ฑ :ย UpperCamelCaseย ์‚ฌ์šฉํ•œ๋‹ค.
    • enum์˜ ๊ฐ case์—๋Š” lowerCamelCase๋ฅผ ์‚ฌ์šฉ

2. ๋„์–ด์“ฐ๊ธฐ, ๋“ค์—ฌ์“ฐ๊ธฐ, ๊ณต๋ฐฑ

  • MARK ์ฃผ์„ ์œ„์™€ ์•„๋ž˜์—๋Š” ๊ณต๋ฐฑ ํ•„์ˆ˜
  • ์ฝœ๋ก (:)์„ ์“ธ ๋•Œ์—๋Š” ์ฝœ๋ก ์˜ ์˜ค๋ฅธ์ชฝ์—๋งŒ ๊ณต๋ฐฑ ๋‘๊ธฐ (๋‹จ, ์‚ผํ•ญ ์—ฐ์‚ฐ์ž์˜ ๊ฒฝ์šฐ ์ฝœ๋ก  ์•ž๋’ค๋กœ ๋„์šฐ๊ธฐ)
  • if let,ย guard letย ๊ตฌ๋ฌธ์ด ๊ธด ๊ฒฝ์šฐ์—๋Š” ์ค„๋ฐ”๊ฟˆํ•˜๊ณ  ํ•œ ์นธ ๋“ค์—ฌ์“ฐ๊ธฐ
  • ์ฝค๋งˆ(,) ๋’ค์— ๊ณต๋ฐฑ ์ถ”๊ฐ€
  • ์—ฐ์‚ฐ์ž ์•ž๋’ค๋กœ ๊ณต๋ฐฑ์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.
  • ํ™”์‚ดํ‘œ(->) ์–‘์ชฝ์— ๊ฐ€๋…์„ฑ์„ ์œ„ํ•ด ๋นˆ ๊ณต๋ฐฑ์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.
  • @objc, ๋ธ”๋Ÿญ ๋‹จ์œ„ ์‚ฌ์ด์—๋Š” ์ค„๋ฐ”๊ฟˆ์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

3. ์ฃผ์„

  • /// ๋ฅผ ์‚ฌ์šฉํ•ด์„œ ๋ฌธ์„œํ™”์— ์‚ฌ์šฉ๋˜๋Š” ์ฃผ์„ ๋‚จ๊ธฐ๊ธฐ
  • // MARK: ๋ฅผ ์‚ฌ์šฉํ•ด์„œ ์—ฐ๊ด€๋œ ์ฝ”๋“œ๋ฅผ ๊ตฌ๋ถ„์ง“๊ธฐ
  • ๊ฐ€๋Šฅํ•œ ์ฝ”๋“œ ์•ˆ์—์„œ ๋ฌธ์„œํ™”๋ฅผ ์ง„ํ–‰ํ•ด์„œ ์ƒ์‚ฐ์„ฑ์„ ์˜ฌ๋ฆด ์ˆ˜ ์žˆ๋„๋ก ์ •๋ฆฌํ•˜๊ธฐ