컨벤션

코딩 컨벤션

기본적으로 Swift style guide를 참고하여 코드를 작성한다. 컨벤션을 지키기 위해 SwiftLint를 사용하여 무의식적으로 지키지 못한 문법을 고칠 수 있도록 한다.

• Swift lint에서 무시할 Convension (링크)

  • trailing_whitespace
  • line_length
  • empty_enum_arguments
  • multiple_closures_with_trailing_closure

• 기본 컨벤션

  class Foo {
  
      private let bar: String
  
      func func1() {
  
      }
  
      func func2() {
  
      }
  
  }

  self는 꼭 필요할 때만 사용 -> 참고자료 안에 멤버함수가 있을 경우에만 중괄호와 내용 사이를 한 칸 띄운다

Commit 템플릿

커밋 템플릿을 git에 적용하여 컨벤션에 맞게 커밋을 작성한다.

# [타입] 제목

##### 제목은 최대 50 글자까지만 입력 ############## -> |


# 본문은 위에 작성
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |

# 꼬릿말은 아래에 작성: ex) #이슈 번호

# --- COMMIT END ---
# <타입> 리스트
#   feat    : 기능 (새로운 기능)
#   fix     : 버그 (버그 수정)
#   refac   : 리팩토링 (코드 수정, 이름 변경)
#   style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음) (개행 삭제, 띄어쓰기)
#   docs    : 문서 (문서 추가, 수정, 삭제)
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 변경사항 (빌드 스크립트 수정 등)
#   merge   : 머지 과정에서의 커밋
#   deploy  : 배포 과정에서의 커밋 
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------

예시

[feat] commit message
    (한 줄 뛰고)
    - 내용

PR 템플릿

Label 종류

• UI / Clustering / Data
• feat / fix / doc / refactor

예시

제목 : 주요 내용 + 레이블 붙이기 

## 구현내용

### [feat] ([docs], [fix],,,)
* navigationController를 추가하고, navigationBar를 커스텀하였습니다
* 새 이슈 추가 버튼을 추가하고, 사이즈 조정을 진행하였습니다
* issueListViewController 파일을 추가하고 스토리보드에서 적용시켰습니다

## 논의사항
추가적으로 주석이나, 코딩 컨벤션 같은 걸 명확히 하지 않아 함수명 짓는데 고민되는 것 같아요
`func setNavigationBar()` 과 같은 이름의 임의로(?) 사용하였는데 같이 얘기 나눠 보고 싶네요❗️

### [화면](선택)
<img width="331" alt="스크린샷 2020-10-29 오전 12 29 12" src="https://user-images.githubusercontent.com/62557093/97458209-d3cd8500-197d-11eb-9b88-d652052cad1e.png">