Home

Cherish Convention

폴더구조

🗂 Global
    - AppModels 🗂
    - Font 🗂
    - View 🗂
    - Extension 🗂
    - Class 🗂
    - Gif 🗂

🗂 Network
    - APIModels 🗂
    - APIServices 🗂

🗂 Screens
    - AddUser 🗂
        - Cells 🗂
        - Controller 🗂
        - Storyboards 🗂
    - ...

🗂 Supports
    - info.plist
    - GoogleService-Info.plist
    - AppDelegate.swift
    - SceneDelegate.swift
    - Assets.xcassets

Commit Messge Rules

반영사항을 바로 확인할 수 있도록 작은 기능 하나라도 구현되면 커밋을 권장합니다.
커밋할 땐 iOS 슬랙에 노티합니다.
기능 구현이 완벽하지 않을 땐, 각자 브랜치에 커밋을 해주세요.

커밋 메시지 명령어 모음

• - feat    : 기능 (새로운 기능)
  - fix     : 버그 (버그 수정)
  - refactor: 리팩토링
  - style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
  - docs    : 문서 (문서 추가, 수정, 삭제)
  - test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
  - chore   : 기타 변경사항 (빌드 스크립트 수정 등)
  

커밋 메세지 형식

• [커밋메세지] 설명 형식으로 커밋 메시지를 작성합니다.

• 커밋 메시지는 영어 사용을 권장합니다.
  좋은 예

  [feat] fetchcontacts!
  

  나쁜 예

  연락처 동기화 기능 추가
  

Git Flow

• 커밋 메세지는 다른 사람들이 봐도 이해할 수 있게 써주세요.
• 풀리퀘스트를 통해 코드 리뷰를 해보아요.

- main
- dev
- feat
  - #1
  - #2

PR Rule

• 1개 이상의 Approve가 일어났을 경우 머지해주세요. [설명]
• main - dev 간 머지: Rebase and Merge
• dev - feat 간 머지: Squash and Merge

네이밍

Class & Struct

• 클래스/구조체 이름은 UpperCamelCase를 사용합니다.

• 클래스 이름에는 접두사를 붙이지 않습니다.

  좋은 예

  class CherishTVC: UITableViewCell

  나쁜 예

  struct cherishCVCInfo { }

함수, 변수, 상수

• 함수와 변수에는 lowerCamelCase를 사용합니다.

• 버튼명에는 Btn 약자를 사용합니다.

• 모든 IBOutlet에는 해당 클래스명을 뒤에 붙입니다.

  • ~~ImageView, ~~Label, ~~TextField와 같이 속성값을 붙여줍니다.

• 테이블 뷰는 TV, 컬렉션뷰는 CV로 줄여서 네이밍합니다.

• 테이블 뷰 셀은 TVC, 컬렉션뷰 셀은 CVC로 줄여서 네이밍합니다.

  좋은 예

  @IBOutlet weak var wateringBtn: UIButton!
  @IBOutlet weak var cherishMainView: UIView!
  @IBOutlet weak var cherishTV: UITableView!

  나쁜 예

  @IBOutlet weak var ScrollView: UIScrollView!
  @IBOutlet weak var cherishcollectionview: UICollectionView!
  @IBOutlet weak var tagcollectionview: UICollectionView!
  @IBOutlet weak var tableview: UITableView!

주석

• 다수의 행이라면 /* */를 사용합니다.
• // MARK: 를 사용해서 연관된 코드를 마크업 하여 구분짓습니다.
  • 마크업 주석을 활용하면 코드 상단의 경로 바를 통해서 이동이 가능합니다. [설명]
• /// 는 Quick Help 주석입니다. 부가적인 설명을 남깁니다. [설명]

기타

• viewDidLoad() 내에는 Function만 위치시킵니다.
• 중복되는 부분들은 Extension으로 만들어 활용합니다.
• 메인컬러와 같이 자주 쓰이는 컬러들은 Asset에 Color Set을 만들어서 사용합니다.
• , 뒤에 반드시 띄어쓰기를 합니다.
• 함수끼리 1줄 개행합니다.
• 중괄호는 아래와 같은 형식으로 사용합니다.

if (condition) {
  /*
  Statements
  */
}