File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- ##Ai-proxy
1+ # Git Commit Convention & Branch Rules
2+
3+ ---
4+
5+ ## 📌 커밋 컨벤션
6+
7+ ### 1. ** 커밋 유형 지정**
8+
9+ 커밋 메시지는 아래 유형 중 하나를 선택하여 ** 대문자로** 작성합니다.
10+
11+ | 커밋 유형 | 의미 |
12+ | ------------------ | ------------------------------------------- |
13+ | ` Feat ` | 새로운 기능 추가 |
14+ | ` Fix ` | 버그 수정 |
15+ | ` Docs ` | 문서 수정 |
16+ | ` Style ` | 코드 포매팅 (코드 변경 X, 세미콜론 누락 등) |
17+ | ` Refactor ` | 코드 리팩토링 |
18+ | ` Test ` | 테스트 코드 추가 및 리팩토링 |
19+ | ` Chore ` | 기타 변경 사항 (ex: .gitignore 수정) |
20+ | ` Design ` | CSS 등 UI 디자인 변경 |
21+ | ` Comment ` | 주석 추가 및 변경 |
22+ | ` Rename ` | 파일/폴더 이름 변경 |
23+ | ` Remove ` | 파일/폴더 삭제 |
24+ | ` !BREAKING CHANGE ` | 주요 API 변경 |
25+ | ` !HOTFIX ` | 치명적인 버그 급히 수정 |
26+
27+ ** 예시:**
28+ ` Feat: 사용자 로그인 기능 구현 (#1) `
29+
30+ ### 2. ** 제목과 본문 분리**
31+
32+ - 제목과 본문 사이에는 ** 빈 줄** 을 추가합니다.
33+ - 본문에는 변경 내용과 이유를 작성합니다.
34+ (어떻게보다는 ** 무엇** 과 ** 왜** 를 중심으로 설명)
35+
36+ ### 3. ** 제목 작성 규칙**
37+
38+ - 제목은 첫 글자를 대문자로 시작하며, 끝에 ` . ` 금지.
39+ - 영문 기준 ** 50자 이내** 로 작성.
40+
41+ ### 4. ** 본문 가독성 높이기**
42+
43+ 여러 변경 사항이 있을 경우 ** 글머리 기호** 를 사용합니다.
44+
45+ ```
46+ - 변경 내용 1
47+ - 변경 내용 2
48+ - 변경 내용 3
49+ ```
50+
51+ ### 5. ** 명확한 설명**
52+
53+ 자신의 코드가 직관적으로 파악되지 않을 수 있으므로 상세히 작성합니다.
54+
55+ ---
56+
57+ ## 🌿 브랜치 생성 규칙
58+
59+ ### 1. 브랜치 네이밍
60+
61+ ` feat ` , ` refactor ` , ` fix ` , ` chore ` 와 함께 ** 이슈 번호** 를 포함해 브랜치를 생성합니다.
62+
63+ ** 예시:** ` feat/#34 `
64+
65+ ### 2. 브랜치 소스 설정
66+
67+ 브랜치를 생성할 때 ** develop 브랜치를 기준** 으로 만듭니다.
68+
69+ 1 . issue 제작
70+ 2 . ` create a branch ` 클릭 후 이름 지정. (브랜치 연결 과정, PR시 용이)
You can’t perform that action at this time.
0 commit comments