라이푸 다이어리

너. 👈🏻 변 💩 했어 ❓

✨ 서비스 이름과 소개

서비스명	서비스 소개
라이푸 다이어리	나의 변의 상태를 체크하고, 친구에게 배변 활동을 응원받고, 변의 변화를 주간 리포트로 확인하자

🚀 iOS-Developers

윤수빈	이승헌	박의서	김인영

🔫 개발 담당 부분

담당 뷰	담당자	구현 기능 설명
Main - RecordPopUpView	`윤수빈`	프로젝트 세팅, 마이푸 기록 모달 뷰, 네트워크 세팅 및 연결
MainView	`이승헌`	메인 뷰, 네트워크 연결
FriendsView	`박의서`	친구 응원하기 뷰, 네트워크 연결
ReportView	`김인영`	마이푸 리포트 뷰

🪧 Library

라이브러리	사용 목적	Version	Management Tool
SnapKit	UI Layout	5.6.0	SPM
Then	UI 선언	3.0.0	SPM
Moya	서버 통신	15.0.3	SPM

🎈 Convention

✨ Git Branch Convention

Branch Naming Rule
- Issue 작성 후 생성되는 번호와 Issue의 간략한 설명 등을 조합하여 Branch 이름 결정
- <Prefix>/<#IssueNumber>-<Description>
Commit Message Rule
- [Prefix] : <Description>

✨ Git Flow

1. 작업 단위별 Issue 생성 : 담당자, 라벨, 프로젝트 연결 

2. Fork 받은 로컬 레포에서 develop 브랜치 최신화 : git pull (origin develop) 

3. Branch 생성 : git switch -c Prefix/#IssueNumber-description 
  > 예시) chore/#3-Project-Setting

4. 로컬 환경에서 작업 후 Add -> Commit -> Push -> Pull Request의 과정을 거친다.
  
  Prefix의 의미
  > [Feat] : 새로운 기능 구현
  > [Chore] : 코드 수정, 패키지 구조 변경, 파일 이동, 파일이름 변경 등
  > [Add] : 코드 변경 없는 단순 파일 추가, 에셋 및 라이브러리 추가
  > [Fix] : 버그, 오류 해결, 코드 수정
  > [Docs] : README나 WIKI 등의 문서 개정
  > [Refactor] : 전면 수정
  > [Setting] : 프로젝트 세팅


5. Pull Request 작성 
  - closed : #IssueNumber로 이슈 연결, 리뷰어 지정

6. Code Review 완료 후 Pull Request 작성자가 develop Branch로 merge하기
  - Develop Branch protection rules : Merge 전 최소 1 Approve 필요

7. 종료된 Issue와 Pull Request의 Label과 Project를 관리

✨ Naming & Code Convention

함수, 메서드 : lowerCamelCase 사용하고, 동사로 시작한다.
변수, 상수 : lowerCamelCase 사용한다.
클래스, 구조체, enum, extension 등 : UpperCamelCase 사용한다.
기본 MVC 폴더링 구조에 따라 파일을 구분하여 사용한다.
파일, 메서드, 클래스 명 약어 사용 지양한다.
- 예시) ViewController → VC (❌)
- 예시) CollectionViewCell → CVC (❌)
- 예시) loginButtonDidTap: UIButton -> loginBtnTapped (❌)
이외 기본 명명규칙은 Swift Style Guide, API Design Guidelines , Swift Style Guide를 참고한다.

✨ Project Foldering

MyPooDiary
┣ Network
┃ ┣ Base
┃ ┃ ┣ APIConstants
┃ ┃ ┣ Encodable+
┃ ┃ ┣ NetworkLoggerPlugin
┃ ┣ Router
┃ ┣ DTO
┣ Global
┃ ┣ Extension
┃ ┣ Supports
┃ ┃ ┣ AppDelegate.swift
┃ ┃ ┗ SceneDelegate.swift
┃ ┗ Literals
┃ ┗ Utils
┃ ┗ Resource
┃ ┃ ┣ Assets
┣ Screens
┃ ┣ Main
┃ ┃ ┣ Model
┃ ┃ ┣ View
┃ ┃ ┗ Controller
┃ ┣ Friends
┃ ┃ ┣ Model
┃ ┃ ┣ View
┃ ┃ ┗ Controller
┃ ┣ Report
┃ ┃ ┣ Model
┃ ┃ ┣ View
┃ ┃ ┗ Controller
┗ Info.plist