Skip to content

Branch Convention

krokerdile edited this page Nov 15, 2024 · 3 revisions

Git Branch Convention

브랜치 구조

main ── develop ── feature

브랜치 종류

브랜치 설명 용도
main 제품 배포용 브랜치 Production 환경
develop 개발 통합 브랜치 테스트 서버 환경
feature 기능 개발 브랜치 로컬 개발 환경

브랜치 운영 규칙

1. 브랜치 Flow

feature → develop → main
  • feature → develop: 기능 개발 완료 후 통합
  • develop → main: 테스트 완료 후 배포

2. 테스트 규칙

  • feature → develop 병합 시 테스트 코드 실행 (Github Action)
  • 테스트 통과 시에만 병합 가능

3. Feature 브랜치 네이밍

feature/#{issue-number}-{feature-name}[-{detail}]

기본 구조

  • feature/#11-mainpage (기본 형태)
  • feature/#11-mainpage-button (상세 작업)

예시

# 메인 페이지 생성 태스크 (#11)
feature/#11-mainpage              # 메인 기능 개발
feature/#11-mainpage-button      # 버튼 추가 작업
feature/#11-mainpage-layout      # 레이아웃 작업

4. 브랜치 생성 규칙

  1. 태스크(이슈) 단위로 브랜치 생성
  2. 하나의 태스크에서 파생되는 작업은 원본 태스크 번호 유지
  3. 세부 작업은 {detail} 형식으로 구분

5. Pull Request 규칙

  1. 최종 병합은 원본 feature 브랜치에서 진행
    • 예: feature/#11-mainpagedevelop
  2. 세부 작업 브랜치는 원본 feature 브랜치로 병합
feature/#11-mainpage-button → feature/#11-mainpage
feature/#11-mainpage-layout → feature/#11-mainpage

주의사항

  1. 브랜치 생성 전 반드시 이슈 번호 확인
  2. 하나의 브랜치는 하나의 목적을 가지도록 구성
  3. 작업 완료된 feature 브랜치는 병합 후 삭제
  4. 브랜치명은 항상 소문자로 작성
  5. 단어 구분은 하이픈(-) 사용

브랜치 관리 워크플로우

  1. 이슈 생성
  2. feature 브랜치 생성
  3. 기능 개발
  4. 테스트 코드 작성 및 실행
  5. develop 브랜치로 PR 생성
  6. 코드 리뷰 및 승인
  7. 병합 후 브랜치 삭제
Clone this wiki locally