Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,18 @@
모든 작업은 `main`에서 브랜치를 따서 시작하고, PR을 통해 병합합니다.

### 📌 브랜치 명명 규칙 (Naming Convention)
**포맷: `[타입]/[이슈번호]-[설명]`**
**포맷: `타입/이슈번호-설명`**
* 모두 **소문자**를 사용합니다.
* 띄어쓰기는 하이픈(-)으로 대체합니다.
* 브랜치 이름에 **`#` 기호를 포함하지 않습니다.** (숫자만 기입)
* 띄어쓰기는 하이픈(`-`)으로 대체합니다.

| 타입 (Prefix) | 설명 | 예시 |
| :--- | :--- | :--- |
| **`feature`** | 새로운 기능 개발 | `feature/#10-login-api` |
| **`fix`** | 버그 수정 | `fix/#12-jwt-error` |
| **`feat`** | 새로운 기능 개발 | `feat/10-login-api` |
| **`fix`** | 버그 수정 | `fix/12-jwt-error` |
| **`refactor`** | 기능 변경 없는 코드 개선 | `refactor/user-dto` |
| **`docs`** | 문서(README, Swagger) 수정 | `docs/api-spec` |
| **`chore`** | 빌드 설정, 라이브러리 추가 | `chore/add-actuator` |
| **`chore`** | 빌드 설정, 라이브러리 추가 | `chore/5-add-actuator` |
| **`test`** | 테스트 코드 작성 | `test/login-service` |

---
Expand All @@ -41,14 +42,14 @@
**✅ 예시**
* `[FEAT] 회원가입 비즈니스 로직 구현`
* `[FIX] 토큰 만료 시간 버그 수정`
* `[DOCS] CONTRIBUTING.md 파일 추가`
* `[CHORE] 브랜치 명명 규칙 가이드라인 추가`

---

## 3. 🚀 협업 워크플로우 (Workflow)

1. **Issue 생성:** 작업할 내용을 이슈 탭에 등록합니다.
2. **Branch 생성:** `main`에서 위 규칙에 맞춰 브랜치를 생성합니다.
3. **Dev & Push:** 작업 후 커밋하고 원격 저장소에 푸시합니다.
4. **PR 생성:** Pull Request를 올리고 리뷰어를 지정합니다.
5. **Review & Merge:** 1명 이상의 승인(Approve)을 받은 후, **Squash and Merge** 합니다.
1. **Issue 생성:** 작업할 내용을 이슈 탭에 등록하고 이슈 번호를 확인합니다.
2. **Branch 생성:** `main`에서 위 규칙에 맞춰 브랜치를 생성합니다.
3. **Dev & Push:** 작업 후 커밋 메시지 규칙을 지켜 푸시합니다.
4. **PR 생성:** Pull Request를 올리고 본문에 `Closes #이슈번호`를 적어 이슈를 연결합니다.
5. **Review & Merge:** 1명 이상의 승인을 받은 후, **Squash and Merge** 합니다.
Loading