Skip to content

Git Convention

Dongmin Park edited this page Jun 18, 2024 · 2 revisions

Type

  • [Feature] : 새로운 기능 구현
  • [Mod] : 코드 수정 및 내부 파일 수정
  • [Add] : 부수적인 코드 추가 및 라이브러리 추가, 새로운 파일 생성
  • [Chore] : 버전 코드 수정, 패키지 구조 변경, 타입 및 변수명 변경 등의 작은 작업
  • [Delete] : 쓸모없는 코드나 파일 삭제
  • [UI] : UI 작업
  • [Fix] : 버그 및 오류 해결
  • [Hotfix] : issue나 QA에서 문의된 급한 버그 및 오류 해결
  • [Merge] : 다른 브랜치와의 MERGE
  • [Move] : 프로젝트 내 파일이나 코드의 이동
  • [Rename] : 파일 이름 변경
  • [Refactor] : 전면 수정
  • [Docs] : README나 WIKI 등의 문서 개정

Branch Convention

  1. 이슈 파기

    • [유형] where / what
    • ex) [UI] 로그인 뷰 / UI 구현
    • [Feature] 로그인 뷰 / api 연결
    • [Fix] 토큰 refresh error 해결
  2. 브랜치 파기

    • 유형/#번호-what
    • feature / hotfix / release
    • ex) feature/#11-login-api-connect
  3. 작업하기

    • 유형 #번호: what
    • commit 예시 (Feature #번호: what)
image
  1. PR 올리기

    • [유형/#번호] what
    • ex) Issue #11에 대해서 완료한 경우 : [Feature/#11] 로그인뷰 api 연결
  2. 어프루브 후 머지하기

    • 3명 중 최소 2명에게 피드백을 받은 후 머지가 가능하도록 설정해둘 예정
    • 확인받은 후 merge 할 때 : [Merge] #11 -> develop
Clone this wiki locally