Skip to content

Git Convention

송혜음 edited this page Nov 18, 2024 · 4 revisions

FLOW

1. 이슈 파기

  • [Type] 작업 내용
  • ex) [setting] 디자인 시스템 정의

2. 브랜치 파기

  • Type/#IssueNumber-작업 내용
  • ex) setting/#1-design-system-color
  • ex) feature/#2-home
  • ex) refactor/#3-home-refactor

3. 작업하기

  • 커밋 메세지
  • Type/#IssueNumber: 작업 내용
    • ex) setting/#1: 디자인 시스템 폰트 정의
    • ex) feature/#2: 홈 뷰 구현
    • ex) feature/#3: 홈 api 연결

4. PR 올리기

  • Type/#IssueNumber: 작업 내용
    • ex) setting/#1: 디자인 시스템 폰트 정의
    • ex) feature/#2: 홈 뷰 구현
    • ex) feature/#3: 홈 api 연결
    • PR 올릴때에는 project 연결 X -> 칸반보드에 이슈/PR 총 두 번 올라가게 되므로 이슈 템플릿에서만 project 연결

5. Merge 하기

  • merge #IssueNumber -> develop
    • 2명 이상의 approve 시 merge가 가능합니다

Branch

  • main
  • develop
  • Type/#IssueNumber-작업 내용

Type

  • [feature] : 기능 구현
  • [add] : 새 파일 생성
  • [mod] : 큰 단위의 코드 수정 (로직 수정 등)
  • [chore] : 작은 단위의 코드 수정 (변수/함수명 수정 등)
  • [delete] : 코드 삭제
  • [fix] : 버그 수정
  • [merge] : 브랜치 병합
  • [refactor] : 코드 리팩토링
  • [docs] : github readme/wiki 문서 작성
  • [setting] : 기초 세팅 (+ font,color)