Skip to content

Latest commit

Β 

History

History
57 lines (43 loc) Β· 2.67 KB

File metadata and controls

57 lines (43 loc) Β· 2.67 KB

Pull Request & Code Review Guidelines

이 λ¬Έμ„œλŠ” 이 ν”„λ‘œμ νŠΈμ˜ Pull Request(PR) μž‘μ„± 및 μ½”λ“œ 리뷰 μ‹œ μ§€μΌœμ•Ό ν•  κ·œμΉ™κ³Ό 포맷을 μ •μ˜ν•©λ‹ˆλ‹€.
κΈ°μ—¬μžμ™€ 리뷰어 λͺ¨λ‘κ°€ 효율적이고 μΌκ΄€λœ ν˜‘μ—…μ„ ν•  수 μžˆλ„λ‘ 도움을 μ€λ‹ˆλ‹€.

βœ… PR μž‘μ„± 포맷

PR을 생성할 λ•ŒλŠ” μ•„λž˜ ν˜•μ‹μ„ 따라 μ£Όμ„Έμš”:

## #️⃣ Issue Number
<!-- ex) #이슈번호, #이슈번호 -->
- μ˜ˆμ‹œ: #32

## πŸ“ μš”μ•½(Summary)
<!-- ν•΄λ‹Ή PR에 λŒ€ν•΄μ„œ κ°„λ‹¨νžˆ μ„€λͺ…ν•΄μ£Όμ„Έμš”(3쀄 이내). (Why? How?) -->
<!-- (세뢀적인 λ‚΄μš©μ€ Issue에 μž‘μ„±λ˜μ—ˆμ„ 것이라고 κ°€μ •ν•©λ‹ˆλ‹€) -->
- μ˜ˆμ‹œ: 브랜치 μ „λž΅ κ°€μ΄λ“œλΌμΈ λ¬Έμ„œ μΆ”κ°€  
- ν”„λ‘œμ νŠΈ λ‚΄ μ»¨νŠΈλ¦¬λ·°μ…˜ 흐름 정리λ₯Ό μœ„ν•œ μž‘μ—…  
- μ‹ κ·œ κΈ°μ—¬μž onboarding μ‹œ μ°Έκ³  λ¬Έμ„œλ‘œ ν™œμš© μ˜ˆμ •

## πŸ’¬  To Reviewers (선택)
<!-- 리뷰어가 μ€‘μ μ μœΌλ‘œ 봐쀬으면 μ’‹κ² λŠ” 뢀뢄이 있으면 μž‘μ„±ν•΄μ£Όμ„Έμš”. -->
- μ˜ˆμ‹œ: λ¬Έμ„œ κ΅¬μ‘°λ‚˜ μš©μ–΄ 선택이 μžμ—°μŠ€λŸ¬μš΄μ§€ 확인 λΆ€νƒλ“œλ¦½λ‹ˆλ‹€.

## PR Checklist
<!-- [x] ν•­λͺ© μ™„λ£Œ μ—¬λΆ€ μ²΄ν¬ν•΄μ£Όμ„Έμš” -->
- [x] λ³€κ²½ 사항에 λŒ€ν•œ ν…ŒμŠ€νŠΈ λ˜λŠ” 검증 μ™„λ£Œ
- [x] λ‘œμ»¬μ—μ„œ 정상 λ™μž‘ 확인
- [ ] κ΄€λ ¨ λ¬Έμ„œ μ—…λ°μ΄νŠΈ μ™„λ£Œ

πŸ” Code Review Emoji Rules

λ¦¬λ·°μ–΄λŠ” μ•„λž˜μ˜ 이λͺ¨μ§€ κ·œμΉ™μ— 따라 ν”Όλ“œλ°±μ„ λ‚¨κ²¨μ£Όμ„Έμš”.
μ„œλ‘œμ˜ μ˜λ„λ₯Ό λͺ…ν™•νžˆ μ „λ‹¬ν•˜λŠ” 데 도움이 λ©λ‹ˆλ‹€.

이λͺ¨μ§€ 의미 μ‚¬μš© μ˜ˆμ‹œ
πŸ‘ μΉ­μ°¬ (Good Job) ꡬ쑰가 κΉ”λ”ν•˜κ³  읽기 μ‰¬μš΄ μ½”λ“œμž…λ‹ˆλ‹€!
❗ ν•„μˆ˜ μˆ˜μ • (Required) 이 뢀뢄은 μ˜ˆμ™Έ μ²˜λ¦¬κ°€ ν•„μš”ν•΄ λ³΄μ—¬μš”. κΌ­ μˆ˜μ •ν•΄μ£Όμ„Έμš”.
❓ 질문 (Clarify) 이 둜직이 이런 λ°©μ‹μœΌλ‘œ κ΅¬μ„±λœ μ΄μœ κ°€ μžˆμ„κΉŒμš”?
πŸ’Š μ œμ•ˆ (Optional Suggestion) 이 뢀뢄은 map λŒ€μ‹  flatMap도 κ³ λ €ν•΄λ³Ό 수 μžˆμ„ 것 κ°™μ•„μš”.

πŸ” 리뷰 ν”„λ‘œμ„ΈμŠ€

  1. PR μƒμ„±μžλŠ” 2λͺ… μ΄μƒμ˜ 리뷰어λ₯Ό μ§€μ •ν•©λ‹ˆλ‹€.
  2. λ¦¬λ·°μ–΄λŠ” μœ„μ˜ 이λͺ¨μ§€ κ·œμΉ™μ— 따라 ν”Όλ“œλ°±μ„ λ‚¨κΉλ‹ˆλ‹€.
  3. 리뷰어 전원이 ❗ ν•­λͺ©μ„ ν•΄μ†Œν•œ ν›„ πŸ‘ λ˜λŠ” 승인(approve)을 남기면 병합 κ°€λŠ₯ν•©λ‹ˆλ‹€.
  4. 병합 μ „μ—λŠ” 가급적 master 브랜치λ₯Ό κΈ°μ€€μœΌλ‘œ μ΅œμ‹  μƒνƒœλ‘œ μœ μ§€ν•΄μ£Όμ„Έμš”.

πŸ“Œ 기타 ꢌμž₯ 사항

  • 컀밋 λ©”μ‹œμ§€λŠ” λͺ…ν™•ν•˜κ³  λͺ©μ  μ€‘μ‹¬μ μœΌλ‘œ μž‘μ„±ν•΄μ£Όμ„Έμš”.
    • 예: docs: add branch guidelines documentation
  • ν•˜λ‚˜μ˜ PRμ—λŠ” κ°€λŠ₯ν•œ ν•œ 의미 μžˆλŠ” λ‹¨μœ„μ˜ μž‘μ—…λ§Œ ν¬ν•¨ν•΄μ£Όμ„Έμš”.
  • κΈ°λŠ₯ λ‹¨μœ„ 컀밋 β†’ PR λ‹¨μœ„ 리뷰 β†’ λ³‘ν•©μ΄λΌλŠ” 흐름을 μ§€μΌœμ£Όμ„Έμš”.