Skip to content

개발컨벤션

Chanhee Jeong edited this page Dec 16, 2022 · 7 revisions

브랜치 전략

Summary

{태그이름}/{#이슈번호}_{간단한 설명}
  • 형식으로 작성한다.

태그 목록

태그 이름 설명
feat 새로운 기능을 추가
fix 버그를 고친 경우
design 사용자 UI 디자인 변경
breaking-change 커다란 API 의 변경
hotfix 급하게 치명적인 버그를 고쳐야하는 경우
style 코드 포맷 변경, 세미 클론 누락 (오타 수정, 탭 사이즈 변경, 변수명 변경)
refactor 프로덕션 코드 리팩토링
comment 필요한 주석 추가 및 변경
docs 문서 수정
test 테스트 추가, 테스트 리팩토링 (프로덕션 코드 변경 X)
chore 빌드 테스트 업데이트, 패키지 매니저를 설정
rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove 파일을 삭제하는 작업만 수행한 경우

코드컨벤션

커밋컨벤션

  • Gitmoji 와 영어사용을 원칙으로 한다
✨ Add blahbalhblah

작업 방식: Issue 및 PR 활용

Issue

  • 작업전 작업내용 Issue 에 추가
    • 하나의 Issue 안에 세부 Issue 활용가능

PR

  • 제목 : [태그이름] 작업내용
  • 본문 : PR 템플릿 활용
## 개요
<!-- 이 PR에 대한 정보를 작성해주세요 / 관련이슈가 있는 경우 아래에 관련 이슈를 등록해주세요 -->
- Closes #1

## 작업내용
<!-- 작업 내용과 이미지를 첨부해주세요. -->
- [] 
- [] 

<!--스크린샷-->


## 리뷰포인트
<!-- 리뷰가 필요한 포인트와 해당 되는 커밋을 링크로 걸어주세요. -->


## Reference
<!-- 참고한 자료를 작성해주세요 -->

## Checklist
- [x] 브랜치를 가져와 작업한 경우 이전 브랜치에 PR을 보냈는지 확인
- [x] 빌드를 위해 SceneDelegate 수정한 것 PR로 올리지 않았는지 확인
- [x] 필요없는 주석, 프린트문 제거했는지 확인
- [x] 컨벤션 지켰는지 확인
- [x] final, private 제대로 넣었는지 확인
- [x] Xcode Team none 으로 되어있는지 확인

코드리뷰

  • 상호 코드리뷰를 필수로 한다
  • 1.0 까지 24시간 이내 코드리뷰를 원칙으로 한다. 단, 예외상황 발생시 미리 알려주기