-
메인 레포에서 이슈를 생성
- 이슈 타이틀과 내용은 템플렛의 규정을 지킴
- Title은 아래의 예시와 같이 커밋컨벤션을 참고하여 작성 예시: [Setting] 프로젝트 초기 세팅을 진행합니다.
- 본인 라벨 + 작업에 맞는 라벨을 등록
-
클론 받은 로컬 main 브랜치에서 새로운 브랜치 생성
- 브랜치 네임은 아래와 같이 커밋컨벤션 Prefix 이후 이슈번호를 같이 작성 또는 특정 기능에 대한 명시적인 이름 사용 예시: setting/#1, feat/signin
-
커밋 메세지는 관련 이슈 번호를 포함
- 예시: feat #1 - 개발한 기능 설명
-
PR은 develop 브랜치로 보낸다.
- PR은 develop 브렌치에서 Merge 이후 테스트를 진행한 후 Main 업로드를 검토
- PR 등록 시 팀원을 Reviewer로 꼭 참조
- PR 작성은 템플릿 예시에 따름
-
리뷰어가 확인하지 않은 PR을 PR을 올린 본인이 Merge하지 않기
[Feat]: 새로운 기능 구현
[Design]: just 화면. 레이아웃 조정
[Fix]: 버그, 오류 해결, 코드 수정
[Add]: Feat 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 View 생성
[Del]: 쓸모없는 코드, 주석 삭제
[Refactor]: 전면 수정이 있을 때 사용합니다
[Remove]: 파일 삭제
[Chore]: 그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 파일이름 변경
[Docs]: README나 WIKI 등의 문서 개정
[Comment]: 필요한 주석 추가 및 변경
[Setting]: 프로젝트 세팅
[Merge]: 머지- 방식 : [Prefix] #이슈번호 - 내용작성
- 예시 : [Setting] #1 - 프로젝트 폴더링
-
네이밍 규칙:
- 클래스, 구조체, 열거형 이름은 UpperCamelCase를 사용합니다.
- 함수, 변수, 상수 이름은 lowerCamelCase를 사용합니다.
- 약어는 모두 대문자로 표기합니다. (예: URL, ID)
-
들여쓰기 및 공백:
- 들여쓰기는 공백 4칸을 사용합니다.
- 콜론(:) 앞에는 공백을 없애고, 콜론 뒤에는 공백을 추가합니다.
- 연산자 앞뒤로 공백을 추가합니다.
- 쉼표(,) 뒤에는 공백을 추가합니다.
if let구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다.- 빈 줄에는 공백이 포함되지 않도록 합니다.
-
줄 길이 제한:
- 한 줄의 길이는 80자 또는 100자를 넘지 않도록 합니다.
- 긴 줄은 적절한 위치에서 줄바꿈하고 들여쓰기를 사용합니다.
-
Import
- 모듈 임포트는 알파벳 순으로 정렬합니다. 내장 프레임워크를 먼저 임포트하고, 빈 줄로 구분하여 서드파티 프레임워크를 임포트합니다.
-
주석:
- 코드의 의도와 목적을 명확히 설명하는 주석을 작성합니다.
///를 사용해서 문서화에 사용되는 주석을 남깁니다.// MARK: -를 사용해서 연관된 코드를 구분짓습니다.
-
브레이스 스타일:
- 여는 중괄호({)는 같은 줄에 위치시키고, 닫는 중괄호(})는 새로운 줄에 위치시킵니다.
- 조건문과 반복문에서 중괄호는 항상 사용합니다.
-
그 외 규칙:
- guard 문을 사용하여 옵셔널 바인딩과 조건 검사를 수행합니다.
- 타입 추론을 활용하되, 명시적으로 타입을 지정해야 할 때는 지정합니다.
- 프로토콜 채택 시 extension을 사용하여 관련 메서드를 그룹화합니다.
- 필요 이상으로 복잡한 코드는 피하고, 간결하고 이해하기 쉽게 작성합니다.