Skip to content

Rule ‐ 브랜치 네이밍 & 커밋메시지 규칙

Kyeongho Jeon edited this page Jan 7, 2025 · 2 revisions

1. 기본 구조

브랜치 이름이나 커밋메시지는 작업 유형과 이슈 번호, 작업 내용을 설명하는 키워드로 구성된다.
작업유형(#이슈번호):작업내용

예시

  • feature(#123)회원가입기능
  • fix(#456)버그수정
  • chore(#789)배포스크립트수정

2. 작업 유형 접두어 규칙

작업 유형을 명확하게 구분하기 위해 아래와 같은 접두어를 사용하자.

접두어 설명 예시
feature 새로운 기능 개발 feature(#101)검색기능추가
fix 버그 수정 fix(#202)로그인버그수정
hotfix 긴급하게 배포해야 하는 버그 수정 hotfix(#303)결제오류수정
chore 코드 변경 이외의 작업 (빌드, 설정 변경 등) chore(#404)릴리스스크립트수정
refactor 리팩토링 (기능 변경 없이 코드 구조 개선) refactor(#505)회원서비스리팩토링
test 테스트 코드 추가 또는 수정 test(#606)결제API테스트추가
doc 문서 수정 및 추가 doc(#707)README수정

3. 규칙 세부사항

3-1. 이슈 번호 이름은 필수

  • 이슈 번호를 포함하여 작업과 연관된 이슈임을 확인할 수 있도록 한다.

3-2. 작업 내용은 간단하고 명확하게

  • 작업 내용을 설명하는 키워드는 간단하고 명확하게 작성한다.

3-3. 소문자 사용

  • 일관성을 위해서 모든 문자는 소문자를 사용한다.