Skip to content

GitHub 룰

김민중 edited this page Nov 14, 2022 · 12 revisions

Commit Convention

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

커밋 메세지 형식

// title
[tag] commit_message (#issue)
// body (optional)
- body_1
- body_2
- ...

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

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

브랜치 규칙

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

  • main
    • 항상 배포 버전으로 유지
  • sprint
    • 주차(스프린트)별 작업사항 백업
    • 매주 금요일 업데이트
    • ex) sprint1, sprint2, ...
  • develop
    • 프로젝트 진행 간 default 브랜치
    • feature 완성 시 업데이트
  • feature
    • 기능 구현
    • develop 으로 PR merge 시 브랜치 삭제
    • ex) feature_mapView, feature_auth, ...
    • 분업 시 해당 브랜치에서 분기
      • ex) feature_mapView_S004, feature_mapView_S049