Skip to content

Commit 631671b

Browse files
committed
docs: add pull_request_guidelines.md
1 parent bb81236 commit 631671b

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

docs/pull_request_guidelines.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Pull Request & Code Review Guidelines
2+
3+
이 문서는 이 프로젝트의 Pull Request(PR) 작성 및 코드 리뷰 시 지켜야 할 규칙과 포맷을 정의합니다.
4+
기여자와 리뷰어 모두가 **효율적이고 일관된 협업**을 할 수 있도록 도움을 줍니다.
5+
6+
## ✅ PR 작성 포맷
7+
8+
PR을 생성할 때는 아래 형식을 따라 주세요:
9+
10+
```md
11+
## #️⃣ Issue Number
12+
<!-- ex) #이슈번호, #이슈번호 -->
13+
- 예시: #32
14+
15+
## 📝 요약(Summary)
16+
<!-- 해당 PR에 대해서 간단히 설명해주세요(3줄 이내). (Why? How?) -->
17+
<!-- (세부적인 내용은 Issue에 작성되었을 것이라고 가정합니다) -->
18+
- 예시: 브랜치 전략 가이드라인 문서 추가
19+
- 프로젝트 내 컨트리뷰션 흐름 정리를 위한 작업
20+
- 신규 기여자 onboarding 시 참고 문서로 활용 예정
21+
22+
## 💬 To Reviewers (선택)
23+
<!-- 리뷰어가 중점적으로 봐줬으면 좋겠는 부분이 있으면 작성해주세요. -->
24+
- 예시: 문서 구조나 용어 선택이 자연스러운지 확인 부탁드립니다.
25+
26+
## PR Checklist
27+
<!-- [x] 항목 완료 여부 체크해주세요 -->
28+
- [x] 변경 사항에 대한 테스트 또는 검증 완료
29+
- [x] 로컬에서 정상 동작 확인
30+
- [ ] 관련 문서 업데이트 완료
31+
```
32+
33+
## 🔍 Code Review Emoji Rules
34+
35+
리뷰어는 아래의 **이모지 규칙**에 따라 피드백을 남겨주세요.
36+
서로의 의도를 명확히 전달하는 데 도움이 됩니다.
37+
38+
| 이모지 | 의미 | 사용 예시 |
39+
|--------|------|-----------|
40+
| 👍 | **칭찬** (Good Job) | 구조가 깔끔하고 읽기 쉬운 코드입니다! |
41+
|| **필수 수정** (Required) | 이 부분은 예외 처리가 필요해 보여요. 꼭 수정해주세요. |
42+
|| **질문** (Clarify) | 이 로직이 이런 방식으로 구성된 이유가 있을까요? |
43+
| 💊 | **제안** (Optional Suggestion) | 이 부분은 `map` 대신 `flatMap`도 고려해볼 수 있을 것 같아요. |
44+
45+
## 🔁 리뷰 프로세스
46+
47+
1. PR 생성자는 **2명 이상의 리뷰어**를 지정합니다.
48+
2. 리뷰어는 위의 이모지 규칙에 따라 피드백을 남깁니다.
49+
3. 리뷰어 전원이 ❗ 항목을 해소한 후 👍 또는 승인(approve)을 남기면 병합 가능합니다.
50+
4. 병합 전에는 가급적 `master` 브랜치를 기준으로 최신 상태로 유지해주세요.
51+
52+
## 📌 기타 권장 사항
53+
54+
- 커밋 메시지는 명확하고 목적 중심적으로 작성해주세요.
55+
- 예: `docs: add branch guidelines documentation`
56+
- 하나의 PR에는 가능한 한 **의미 있는 단위의 작업**만 포함해주세요.
57+
- 기능 단위 커밋 → PR 단위 리뷰 → 병합이라는 흐름을 지켜주세요.

0 commit comments

Comments
 (0)