Git: Branch 네이밍 컨벤션

Table of Content

브랜치 관리

브랜치 종류

  • wip : 작업 진행 중인 임시 브랜치
    • feature-1064-add_something 브랜치에 대한 WIP 브랜치는 다음과 같음 Ex. wip-1064-add_something wip 브랜치는 feature-1064-add_something 브랜치에 merge후 삭제
  • bug
  • hotfix : 일정 또는 상황에 의해서 임시 조치 하는 브랜치
    • hotfix 처리 방법
      • hotfix 브랜치 생성 후 푸시
      • 테스트 후 브랜치 태그를 생성
      • 브랜치 태그로 임시 배포
        • v0.0.1-rc1+x86-hotfix-4302-change_route_url
      • bug 브랜치 생헝
      • hotfix 브랜치와 호환성을 유지하면서 bug 브랜치에서 문제를 해결
      • 최종 develope → main → release 브랜치 순서로 병합
  • feature
  • develop
  • experimental
  • main or master
  • release

브랜치 네이밍 규칙

Best practice

<issue type>-<ID>-<short description>

Ex. bug-10001-face-detection, feature-20034-File-load

  • 구분자는 Hyphend이나 Underscore를 사용합니다.
  • 숫자만 쓰는 것을 피합니다.
  • 지나치게 길고 세세한 브랜치 네이밍은 피합니다.
    Ex. wip_login_module_which_will_used_in_the_public_websitewip_login_module_which_will_used_in_the_internal_website


참고 문헌

https://learn.openwaterfoundation.org/owf-learn-git/workflow/branch-naming/

https://dpericich.medium.com/how-to-write-great-git-branch-names-to-improve-your-team-3345aee7fc2a

Related Posts

답글 남기기

이메일 주소는 공개되지 않습니다.