Skip to content
forked from EAT-SSU/iOS

🍽️ EAT-SSU: μˆ­μ‹€λŒ€ 학식 리뷰 μ•± 🍽️ iOS λ ˆν¬μ§€ν† λ¦¬

Notifications You must be signed in to change notification settings

jayn2u/EATSSU-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: λ₯Ό μ‚¬μš©ν•΄μ„œ μ—°κ΄€λœ μ½”λ“œλ₯Ό ꡬ뢄짓기
  • κ°€λŠ₯ν•œ μ½”λ“œ μ•ˆμ—μ„œ λ¬Έμ„œν™”λ₯Ό μ§„ν–‰ν•΄μ„œ 생산성을 올릴 수 μžˆλ„λ‘ μ •λ¦¬ν•˜κΈ°

Folder Structure

IOS
 ┣ EATSSU_MVC
 ┃  ┣ EATSSU_MVC
 ┃  ┃  β”— Sources
 ┃  ┃     ┣ Data
 ┃  ┃     ┃  ┣ Firebase
 ┃  ┃     ┃  ┣ LocalDB
 ┃  ┃     ┃  β”— Network
 ┃  ┃     ┣ Notification
 ┃  ┃     ┣ Presentation
 ┃  ┃     ┃  ┣ Auth
 ┃  ┃     ┃  ┃  ┣ Enum
 ┃  ┃     ┃  ┃  ┣ View
 ┃  ┃     ┃  ┃  β”— ViewController
 ┃  ┃     ┃  ┣ Home
 ┃  ┃     ┃  ┃  ┣ Enum
 ┃  ┃     ┃  ┃  ┣ Model
 ┃  ┃     ┃  ┃  ┣ Protocol
 ┃  ┃     ┃  ┃  ┣ View
 ┃  ┃     ┃  ┃  β”— ViewController
 ┃  ┃     ┃  ┣ MyPage
 ┃  ┃     ┃  ┃  ┣ Enum
 ┃  ┃     ┃  ┃  ┣ Model
 ┃  ┃     ┃  ┃  ┣ View
 ┃  ┃     ┃  ┃  β”— ViewController
 ┃  ┃     ┃  β”— Review
 ┃  ┃     ┃     ┣ View
 ┃  ┃     ┃     β”— ViewController
 ┃  ┃     β”— Utility
 ┃  β”— UnitTests
 ┣ EATSSU_MVVM
 ┃  β”— EATSSU_MVVM
 ┃     β”— Sources
 ┣ EATSSUComponents
 ┃  β”— EATSSUComponents
 ┃     β”— Sources
 ┃        β”— Extension
 ┣ fastlane
 ┣ Tuist
 β”— 기타 νŒŒμΌλ“€

About

🍽️ EAT-SSU: μˆ­μ‹€λŒ€ 학식 리뷰 μ•± 🍽️ iOS λ ˆν¬μ§€ν† λ¦¬

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Swift 99.6%
  • Ruby 0.4%