|
| 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