CodingConvention

Coding Convention

폴더구조

🗂 Resources

    - AppDelegate

    - SceneDelegate

    - Assets
    
    - APIServices 🗂

    - Storyboards 🗂

    - Font 🗂

🗂 Sources

    - VC 🗂

        - CherishMain 🗂

        - Watering 🗂

        - AddUser 🗂

        - ...

    - Class 🗂

    - Cell 🗂

    - Model 🗂

    - Extension 🗂

info.plist

폴더링 규칙

• 폴더링 한 후 Sources 폴더에 있는 파일들은 각 파일 하위에 자신 스토리보드 이름에 해당하는 폴더를 만들어 관리합니다.
  

• 파일 네이밍 시, 접두에 스토리보드이름을 붙여서 네이밍합니다.

  • (ex. 스토리보드 이름이 Main, Watering이라고 가정했을 때 cell파일 생성 시 MainBlahblahCVC, WateringBlahblahTVC와 같이 네이밍합니다.)

네이밍

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: 를 사용해서 연관된 코드를 구분짓습니다.
• /// 를 사용해서 문서화에 사용되는 주석을 남깁니다. (ex. /// 사용자 프로필을 그려주는 뷰)

기타

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

if (condition){

  Statements
  /*
  ...
  */
  
}

Commit Messge Rules

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

커밋 메시지 명령어 모음

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

커밋 메세지 형식

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

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

  [Feat] fetchcontacts!
  

  나쁜 예

  연락처 동기화 기능 추가
  

Github mangement

• main 브랜치

메인(main): 메인 브랜치

기능(cherish뷰이름): 기능별 (뷰별) 로컬 브랜치

• 커밋 메세지는 다른 사람들이 봐도 이해할 수 있게 써주세요.

• 풀리퀘스트를 통해 코드 리뷰를 해보아요.

- Main
   ├── cherishMainView(각 Local Branch)
   ├── cherishAddView    
   └── cherishWateringView

각자 자신이 맡은 기능 구현에 성공시! 브랜치 다 쓰고 병합하는 방법

• 브랜치 만듦

git branch 기능(or 뷰)이름

• 원격 저장소에 로컬 브랜치 push

git push --set-upstream origin 브랜치이름(뷰이름)

git push -u origin 브랜치이름(뷰이름)

• 브랜치 전환

git checkout 뷰이름

• 코드 변경 (현재 뷰이름 브랜치)

git add .
git commit -m "커밋 메세지" origin 뷰이름

• 푸시 (현재 뷰이름 브랜치)

git push origin 뷰이름 브랜치

• 뷰이름 브랜치에서 할 일 다 했으면 main 브랜치로 전환

git checkout main

• 머지 (현재 main 브랜치)

git merge 뷰이름

• 다 쓴 브랜치 삭제 (local) (현재 main 브랜치)

git branch -d 뷰이름

• 다 쓴 브랜치 삭제 (remote) (현재 main 브랜치)

git push origin :뷰이름

• main pull (현재 main 브랜치)

git pull or git pull origin main

• main push (현재 main 브랜치)

git push or git push origin main