Skip to content

Repository files navigation

Git Commit Convention & Branch Rules


📌 커밋 컨벤션

1. 커밋 유형 지정

커밋 메시지는 아래 유형 중 하나를 선택하여 대문자로 작성합니다.

커밋 유형의미
Feat새로운 기능 추가
Fix버그 수정
Docs문서 수정
Style코드 포매팅 (코드 변경 X, 세미콜론 누락 등)
Refactor코드 리팩토링
Test테스트 코드 추가 및 리팩토링
Chore기타 변경 사항 (ex: .gitignore 수정)
DesignCSS 등 UI 디자인 변경
Comment주석 추가 및 변경
Rename파일/폴더 이름 변경
Remove파일/폴더 삭제
!BREAKING CHANGE주요 API 변경
!HOTFIX치명적인 버그 급히 수정

예시:Feat: 사용자 로그인 기능 구현 (#1)

2. 제목과 본문 분리

  • 제목과 본문 사이에는 빈 줄을 추가합니다.
  • 본문에는 변경 내용과 이유를 작성합니다.
    (어떻게보다는 무엇를 중심으로 설명)

3. 제목 작성 규칙

  • 제목은 첫 글자를 대문자로 시작하며, 끝에 . 금지.
  • 영문 기준 50자 이내로 작성.

4. 본문 가독성 높이기

여러 변경 사항이 있을 경우 글머리 기호를 사용합니다.

 - 변경 내용 1
- 변경 내용 2
- 변경 내용 3

5. 명확한 설명

자신의 코드가 직관적으로 파악되지 않을 수 있으므로 상세히 작성합니다.


🌿 브랜치 생성 규칙

1. 브랜치 네이밍

feat, refactor, fix, chore와 함께 이슈 번호를 포함해 브랜치를 생성합니다.

예시:feat/#34

2. 브랜치 소스 설정

브랜치를 생성할 때 develop 브랜치를 기준으로 만듭니다.

  1. issue 제작
  2. create a branch 클릭 후 이름 지정. (브랜치 연결 과정, PR시 용이)

About

생성형 AI를 이용한 STT 기술 기반의 아이디에이션 브레인스토밍 서버 레포

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages