Skip to content

Git 컨벤션

scnoh edited this page Apr 19, 2024 · 3 revisions

동치미 Git 컨벤션

Git 메시지 규칙

Remote 저장소에 push 할 때 다음의 메시지 컨벤션을 따릅니다: [${type} {version}] {message}

예시

  • [feat 1.2.0] 로그인 기능 추가
  • [fix 1.2.1] 로그인 버그 수정
  • [refactor 1.3.0] 로그인 관련 코드 리팩토링
  • [test 1.3.0] 로그인 테스트 코드 추가

Git Type 설명

  • feat: 기능 개발이 이루어지는 feature 브랜치에서 새로운 기능이나 환경 추가 시 사용
  • fix: 기능에 대한 버그 수정 사항을 push 할 때 사용
  • refactor: 기능 개발 후 코드 개선이 이루어질 때 사용
  • test: 새로운 테스트 코드 작성 시 사용

브랜치 전략

main 브랜치

  • 제품을 출시하는 버전을 관리합니다.
  • 이 브랜치는 항상 안정적이고 실행 가능한 상태여야 합니다.

develop 브랜치

  • 다음 출시 버전을 준비하기 위한 브랜치입니다.
  • 모든 기능 개발이 완료되고 테스트를 거쳐 안정성이 확보된 코드만 main 브랜치로 병합됩니다.

feature 브랜치

  • 각 기능 개발을 위해 생성됩니다.

  • 작업이 시작되는 이슈나 기능 별로 다음과 같은 형식을 따릅니다: feature/#{issue-number}

  • 예: feature/#123

hotfix 브랜치

  • 출시된 제품에서 긴급하게 발생한 버그를 수정하기 위한 브랜치입니다.
  • 필요한 수정을 빠르게 main 및 develop 브랜치에 반영할 수 있도록 합니다.