Skip to content

GitHub 룰

Jisu Hong edited this page Dec 4, 2022 · 12 revisions

Commit 컨벤션

태그 이름 설명 상세
feat 새로운 기능 추가  
fix 버그 fix  
design UI 디자인 변경  
refactor 코드 리팩토링 동작 및 기능에는 변화가 없고 코드에만 변화가 있는 경우
comment 주석 추가 및 변경  
docs 문서 수정 README, Lint, Pod, PR 템플릿, ISSUE 템플릿 등…
test 테스트 코드 추가, 테스트 리팩토링 프로덕션 코드 변경 X
chore 빌드 태스크 업데이트, 패키지 매니저 등 프로덕션 코드 변경 X
rename 파일 혹은 폴더명 수정, 위치 변경  
remove 파일 혹은 폴더 삭제  
  • 이슈에 필수로 연결할 항목 : feat, fix, design, test

Commit 메세지 형식

// title
[tag] commit_message (#issue)

// body (optional)
- body_1
- body_2
- ...

// 예시1
[feat] 지도에 개봉 가능한 캡슐 출력 (#10)

// 예시2
[fix] Firebase 에러 핸들링 수정 (#9)
- 원래 400 번대 에러가 안잡혔음

브랜치 규칙

변형된 Git Flow 모델을 사용한다.

  • main
    • 항상 배포 버전으로 유지
  • develop
    • 프로젝트 진행 간 default 브랜치
    • feature 완성 시 업데이트
  • feature
    • 기능 구현
    • develop 으로 PR merge 시 브랜치 삭제
    • ex) feature_mapView, feature_auth, ...
    • 분업 시 해당 브랜치에서 분기
      • ex) feature_mapView_S004, feature_mapView_S049

PR 룰

  • PR merge 시 최소 1명에게 컨펌받기
    • 2시간 이내 리뷰, merge 까지 진행
    • conflict 발생 시 merge 는 둘이서 같이 진행