μ΄λ³΄ κ°λ°μλ₯Ό μν GitHub Pull Request λ§λ€κ³ μ½λ 리뷰 λ°λ λ²(μ€μ΅ μ€μ¬)
μ΄λ³΄ κ°λ°μλ₯Ό μν GitHub Pull Request λ§λ€κ³ μ½λ 리뷰 λ°λ λ²(μ€μ΅ μ€μ¬) μ²μ PR(Pull Request)μ μ¬λ¦΄...
μ΄λ³΄ κ°λ°μλ₯Ό μν GitHub Pull Request λ§λ€κ³ μ½λ 리뷰 λ°λ λ²(μ€μ΅ μ€μ¬)
μ²μ PR(Pull Request)μ μ¬λ¦΄ λ μ μΌ κΈ΄μ₯λλ μκ°μ βλ΄ μ½λκ° λκ΅°κ°μκ² λ³΄μΈλ€βλ μ¬μ€μ΄μ£ . κ·Έλ°λ° ν λ²λ§ νλ¦μ μ λλ‘ μ‘μλλ©΄, PRμ νΌλλ μλ¦¬κ° μλλΌ λ λΉ λ₯΄κ² μ±μ₯νλ 루ν΄μ΄ λ©λλ€. μ€λμ βμκ² λ°κΎΈκ³ , λͺ ννκ² μ€λͺ νκ³ , 리뷰λ₯Ό μ λ°λβ λ°©μμΌλ‘ PRμ μ§μ λ§λ€μ΄λ³΄κ² μ΅λλ€.
1) PRμ΄ λκ³ , μ νμνκ°
PRμ λ΄κ° λ§λ λ³κ²½μ¬νμ λ©μΈ λΈλμΉμ ν©μΉκΈ° μ μ νμ(λλ μ€νμμ€ λ©μΈν μ΄λ)μκ² λ³΄μ¬μ£Όκ³ ν λ‘ νλ κ³Όμ μ λλ€.
- λ³κ²½μ¬ν 곡μ : μ΄λ€ μλλ‘ λ¬΄μμ λ°κΏ¨λμ§ κΈ°λ‘
- κ²μ¦: λ²κ·Έ/μ€μ/μ£μ§ μΌμ΄μ€λ₯Ό λ€λ₯Έ μμ μΌλ‘ νμΈ
- μ§μ μ ν: 리뷰 μ½λ©νΈ μμ²΄κ° λ¬Έμκ° λ¨
2) μ€μ΅ μλ리μ€: λ¬Έμ ν μ€ μμ μΌλ‘ PR μ¬λ¦¬κΈ°
μ²μμ μ½λλ³΄λ€ README κ°μ λ¬Έμ μμ μ΄ λΆλ΄μ΄ μ μ΅λλ€. μλ₯Ό λ€μ΄ README.mdμ μ¬μ©λ² ν μ€μ μΆκ°ν΄ PRμ μ¬λ €λ³Όκ²μ.
2-1. μ μ₯μ ν¬ν¬/ν΄λ‘ & λΈλμΉ λ§λ€κΈ°
ν°λ―Έλμμ μλμ²λΌ μ§νν©λλ€.
git clone μ μ₯μμ£Όμ
cd μ μ₯μν΄λ
git checkout -b docs/add-usage
λΈλμΉ μ΄λ¦μ 무μμ νλμ§ νλμ 보μ΄κ² μ§λ κ² μ’μ΅λλ€. (docs/, fix/, feat/ κ°μ μ λμ΄λ ν κ·μΉμ λ§μΆμΈμ.)
2-2. λ³κ²½νκ³ μ»€λ°νκΈ°
README.mdμ ν μ€ μΆκ° ν μν νμΈ:
git status
git add README.md
git commit -m "docs: add usage line to README"
μ»€λ° λ©μμ§λ μ§§μ§λ§ ꡬ체μ μΌλ‘. βupdateβ κ°μ λ¨μ΄λ§ μ°λ©΄ λμ€μ λ΄κ° λ΄λ κΈ°μ΅μ΄ μ λ©λλ€.
2-3. νΈμνκ³ PR λ§λ€κΈ°
git push -u origin docs/add-usage
μ΄μ GitHubμμ βCompare & pull requestβ λ²νΌμ λλ¬ PRμ μμ±ν©λλ€.
3) λ¦¬λ·°κ° μ λ¬λ¦¬λ PR μμ±λ²(ν΅μ¬)
PR λ³Έλ¬Έμ κΈΈκ² μ°λ κΈμ΄ μλλΌ, 리뷰μ΄μ μκ°μ μκ»΄μ£Όλ μλ΄μμ λλ€. μλ ν νλ¦Ώμ²λΌ μμ±ν΄λ³΄μΈμ.
3-1. PR ν νλ¦Ώ μμ
Title: docs: README μ¬μ©λ² ν μ€ μΆκ°
Body
- λ³κ²½ μμ½: READMEμ μ€ν μμ λ¬Έμ₯ 1μ€ μΆκ°
- λ³κ²½ μ΄μ : μ²μ 보λ μ¬μ©μκ° μ€ν λ°©λ²μ λ°λ‘ μ΄ν΄νκΈ° μ΄λ ΅λ€λ νΌλλ°±μ΄ μμ΄ λ³΄μ
- ν μ€νΈ λ°©λ²: README λ λλ§ νμΈ, λ¬Έμ₯/μμ κΉ¨μ§ μμ
- μ€ν¬λ¦°μ·/κ²°κ³Ό: (λ¬Έμλ©΄ μλ΅ κ°λ₯)
- κ΄λ ¨ μ΄μ: (μλ€λ©΄) #λ²νΈ μ¬κΈ°μ ν¬μΈνΈλ βμβμ βμ΄λ»κ² νμΈνλμ§βμ λλ€. μ΄ λ μ€λ§ μ μ¨λ 리뷰 μλκ° ν μ¬λΌκ°λλ€.
3-2. PR ν¬κΈ°λ μκ², λ Όμ μ νλλ‘
μ΄λ³΄ λ κ°μ₯ νν μ€μ:
- λ¬Έμ μμ PRμ λΆνμν ν¬λ§·ν λμ²μ
- κΈ°λ₯ μΆκ°νλ©΄μ 리ν©ν°λ§κΉμ§ ν λ²μ PRμ΄ μ»€μ§λ©΄ λ¦¬λ·°κ° λ¦μ΄μ§κ³ , νΌλλ°±λ λλ±κ·Έλ €μ§λλ€. κ°λ₯νλ©΄ ν PR = ν λͺ©μ μΌλ‘ μͺΌκ°μΈμ.
4) μ½λ 리뷰 μμ²νλ μλ Ή(λ§ κ±ΈκΈ° μ΄λ ΅λ€λ©΄ μ΄λ κ²)
리뷰λ βλ΄μ£ΌμΈμβκ° μλλΌ μ΄λλ₯Ό λ΄λ¬λΌκ³ μμ²νλ κ² μ’μ΅λλ€.
- βλ‘μ§μ λ¨μνλ°, μλ¬ μ²λ¦¬ λ°©μμ΄ μ μ νμ§ λ΄μ£Όμ€ μ μμκΉμ?β
- βν¨μ μ΄λ¦μ΄ μ λ§€νλ° λ μ’μ λ€μ΄λ°μ΄ μμκΉμ?β
- βμ΄ λΆλΆ μ±λ₯ μ΄μκ° μμμ§ κ°μ΄ μ μ΅λλ€. μ²΄ν¬ λΆνλλ €μ.β λ, κΈνλ©΄ PR λ³Έλ¬Έμ 리뷰 μ°μ μμλ₯Ό μ μ΄λμΈμ. μ: βν΅μ¬ λ³κ²½μ parser.pyμ parse() ν¨μ, λλ¨Έμ§λ ν μ€νΈ μ½λμ λλ€.β
5) 리뷰 μ½λ©νΈ λμ: μ΄λ³΄κ° μμ£Ό λ§νλ 3κ°μ§
5-1. μ§μ λ°μΌλ©΄ λ°©μ΄μ μΌλ‘ λκ»΄μ§ λ
리뷰λ μ¬λ νκ°κ° μλλΌ μ½λ νμ§μ μ¬λ¦¬λ λνμ λλ€. λͺ¨νΈνλ©΄ μ΄λ κ² λ¬Όμ΄λ³΄μΈμ: βμ΄ λ°©μμ΄ λ μ’μ μ΄μ κ° μμκΉμ? μ κ° λμΉ μΌμ΄μ€κ° κΆκΈν©λλ€.β
5-2. μμ 컀λ°μ μ΄λ»κ² μ¬λ¦¬λ
μ½λ©νΈ λ°μ ν λμΌ λΈλμΉμ 컀λ°νκ³ νΈμνλ©΄ PRμ μλ λ°μλ©λλ€.
git add .
git commit -m "fix: address review comments"
git push
5-3. λνλ λ¨κΈ°κ³ , ν΄κ²°μ λͺ ννκ²
μ½λ©νΈλ₯Ό λ°μνλ€λ©΄ GitHubμμ ν΄λΉ μ€λ λμ βλ°μνμ΅λλ€. ~ λ°©μμΌλ‘ μμ νκ³ ν μ€νΈλ ν΅κ³Όνμ΅λλ€.βμ²λΌ μ§§κ² κ²°κ³Όλ₯Ό 곡μ νκ³ Resolve μ²λ¦¬ν©λλ€.
6) λ¨Έμ§ μ λ§μ§λ§ 체ν¬λ¦¬μ€νΈ
PR μ λͺ©μ΄ λ³κ²½λ΄μ©μ λννλ€
βμ λ°κΏ¨λμ§βκ° λ³Έλ¬Έμ μλ€
ν μ€νΈ/νμΈ λ°©λ²μ μ μλ€
λΆνμν νμΌ λ³κ²½μ΄ μλ€
리뷰 μ½λ©νΈμ λ΅μ΄ λ¬λ € μλ€
PRμ ν λ²μ μλ²½νλ €κ³ μ¬λ¦¬λ κ² μλλΌ, 리뷰λ₯Ό ν΅ν΄ μ’μμ§λλ‘ μ¬λ¦¬λ κ²μ λλ€. μ€λμ λ¬Έμ ν μ€λ‘ μμνμ§λ§, κ°μ νλ¦μΌλ‘ κΈ°λ₯ μΆκ° PRλ μΆ©λΆν ν μ μμ΄μ. λ€μ λ¨κ³λ‘λ βν μ€νΈ μ½λ ν¬ν¨ PRβμ ν λ² λ§λ€μ΄λ³΄λ©΄ μ±μ₯ μλκ° ν λ¬λΌμ§λλ€.
β¬οΈ μ΄ κΈμ΄ λμμ΄ λμ ¨λ€λ©΄, μλ κ΄κ³ λ₯Ό ν λ²λ§ ν΄λ¦ν΄μ£ΌμΈμ! μ μκ² ν° νμ΄ λ©λλ€ πββοΈ β¬οΈ