README.md

🏊🏻‍♂️ 카카오웹툰 iOS

🙆🏻‍♀️🙅🏻‍♂️ 프로젝트 설명

🌟 35rd SOPT 합동세미나 앱 9팀, 카카오웹툰

🍎 역할 분담 및 주요 기능

👑정지원	김승원	김현수
episode	search, storage	main
웹툰 상세	검색, 보관함	메인 홈

📌Coding Convention

1️⃣ Class 이름

UpperCamelCase를 사용합니다.

• ViewController, TableViewCell, CollectionViewCell 줄이지 않고 사용
• 타입 이름(클래스, 프로토콜, 구조체, enum)만 Upper CamelCase → 그 외에는 모두 Lower CamelCase

2️⃣ Protocol 사용 시

extension으로 모두 빼기 : 하나의 extension에 프로토콜 하나씩

• 프로토콜에서 정의하는 메서드는 확장(Extension)을 통해 구현

3️⃣ 변수 및 상수 이름

• 알아볼 수 있는 네이밍을 사용해주세요!

• lowerCamelCase를 사용합니다.

• 약어인 경우 CamelCase라고 하더라도 모두 대문자로 씀

  대문자로만 쓰는 용어 모음

  
  - URL
  - ID
  - API
  - 필요시 여기에 추가
  

• myContentCollectionViewCell (O)

  myContentCVCell (x)

4️⃣ 줄바꿈

• 줄바꿈 (Ctrl+M) → 함수 매개변수 너무 많을 때(3개 이상)는 각 매개변수당 줄바꿈
• 함수와 함수 사이에 한 줄 공백
• 타입을 정의할 때나, 확장(Extension) 시에는 스코프 맨 위, 아래 한 줄씩 띄우기
• 상위 클래스의 메서드를 재정의(override)하는 경우에는, super 메서드를 호출하고, 한 줄을 띄어 쓴다.

5️⃣ 주석

• 주석은 최대한 지양하자 (PR로 설명 남기기)
• 주석을 quick help로 달기(///)
• command + option + /
• 코드만 봤을 때 이해하기 힘들 것 같은 경우
• 함수의 용도를 (가급적 한 줄 이내로) 설명해야 가능할 때 한에 사용

📌Commit Convention

• [Feat] : 새로운 기능 구현
• [Fix] : 버그, 오류 해결
• [Chore] : 코드 수정, 내부 파일 수정, 애매한 것들이나 잡일은 이걸로!
• [Add] : 라이브러리 추가, 에셋 추가
• [Del] : 쓸모없는 코드 삭제
• [Docs] : README나 WIKI 등의 문서 개정
• [Refactor] : 전면 수정이 있을 때 사용합니다
• [Setting] : 프로젝트 설정관련이 있을 때 사용합니다.
• [Merge] - {#이슈번호} Pull Develop

Message

커밋 메시지 : [종류/#이슈번호]작업 이름 - 예시 [Feat/#1] 메인 UI 구현

Conflict 해결 시 : [Conflict/ #이슈] Conflict 해결

PR을 main에 merge 시 : 기본 머지 메시지

내 브랜치에 main에 merge 시 (브랜치 최신화) : [Merge/#이슈] Pull Develop - [Merge/#13] Pull Develop

📌Issue Convention

Branch

브랜치명 시작은 소문자로 한다.

default branch : main

작업 branch : 커밋타입/이슈번호 - 작업뷰 - 예시 feat/#12-MainView

Issue

이슈 이름 : [종류] 작업 명 - 예시 [Feat] Main View UI 구현

담당자, 라벨 추가 꼭 하기

📂 Foldering Convention

├── Application
│   ├── Appdelegate
│   ├── SceneDelegate
├── Global
│   ├── Extension
│   ├── Literals
│   │   ├── Literal
│   │   ├── String
│   ├── Protocols
│   ├── Resources
│   │   ├── Font
│   │   ├── Assets
│   │   ├── Info.plist
│   ├── SupportingFiles
│   │   ├── Base
├───├───├───── LaunchScreen
├── Network
│   ├── Base
│   ├── DataModel
│   ├── Service
├── Presentation 
│   ├── Common
│   │   ├── UIComponents 
│   ├── Home
│   │   ├── ViewControllers
│   │   ├── Views
│   │   ├── Models
├───├───├── Cells
│   ├── Search
│   │   ├── ViewControllers
│   │   ├── Views
│   │   ├── Models
├───├───├── Cells
│   ├── Storage
│   │   ├── ViewControllers
│   │   ├── Views
│   │   ├── Models
├───├───├── Cells
│   ├── Episode
│   │   ├── ViewControllers
│   │   ├── Views
│   │   ├── Models
├───├───├── Cells