feature명명 규칙

가장 일반적이고 널리 사용되는 규칙

1. 기능 (Feature) 브랜치:

• 규칙: feature/<기능-요약>
• 설명: 새로운 기능 개발을 위한 브랜치임을 나타냅니다. <기능-요약>은 해당 기능의 핵심 내용을 간결하게 설명하는 영어 단어를 사용합니다. 단어 사이는 하이픈(-)으로 구분하는 것이 일반적입니다.
• 예시:
  • feature/user-authentication (사용자 인증 기능)
  • feature/shopping-cart (쇼핑 카트 기능)
  • feature/image-upload (이미지 업로드 기능)
  • feature/new-api-endpoints (새로운 API 엔드포인트)

2. 버그 수정 (Bugfix) 브랜치:

• 규칙: bugfix/<이슈-번호>-<버그-요약> 또는 bugfix/<버그-요약>
• 설명: 발견된 버그를 수정하기 위한 브랜치임을 나타냅니다. <이슈-번호>는 버그 추적 시스템(예: Jira, GitHub Issues)의 이슈 번호를 포함하여 버그를 명확하게 참조할 수 있도록 합니다. <버그-요약>은 해당 버그의 내용을 간결하게 설명합니다.
• 예시:
  • bugfix/123-login-redirect-error (이슈 123, 로그인 리다이렉트 오류 수정)
  • bugfix/456-typo-in-homepage (이슈 456, 홈페이지 오타 수정)
  • bugfix/data-corruption-on-save (저장 시 데이터 손상 버그 수정)

3. 릴리스 (Release) 브랜치:

• 규칙: release/<버전>
• 설명: 특정 버전 릴리스를 준비하기 위한 브랜치입니다. 이 브랜치에서 최종 테스트, 문서 업데이트 등의 작업을 수행합니다.
• 예시:
  • release/1.0.0
  • release/1.1.0-beta

4. 핫픽스 (Hotfix) 브랜치:

• 규칙: hotfix/<버전>-<핫픽스-요약> 또는 hotfix/<이슈-번호>-<핫픽스-요약>
• 설명: 프로덕션 환경에서 발생한 심각한 버그를 긴급하게 수정하기 위한 브랜치입니다. 릴리스 브랜치에서 분기될 수도 있고, master 브랜치에서 직접 분기될 수도 있습니다.
• 예시:
  • hotfix/1.0.1-security-vulnerability (버전 1.0.1, 보안 취약점 수정)
  • hotfix/567-critical-payment-gateway-issue (이슈 567, 결제 게이트웨이 심각한 문제 수정)

5. 실험 (Experiment) 브랜치 (선택 사항):

• 규칙: experiment/<실험-요약> 또는 sandbox/<실험-요약>
• 설명: 실험적인 아이디어나 새로운 기술을 탐색하기 위한 브랜치입니다. 이 브랜치에서의 작업은 최종 제품에 포함되지 않을 수도 있습니다.
• 예시:
  • experiment/new-ui-framework
  • sandbox/explore-graphql
    
    gpt선생, 좋소