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
Lines changed: 57 additions & 0 deletions
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)