Skip to content

Commit

Permalink
Merge pull request #104 from boostcampwm-2024/Docs-1
Browse files Browse the repository at this point in the history
[ENV][Docs] #1 : PR ν…œν”Œλ¦Ώ μž‘μ„±
  • Loading branch information
effozen authored Nov 6, 2024
2 parents e94c50d + ccc9565 commit 296e995
Showing 1 changed file with 87 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/pr-ν…œν”Œλ¦Ώ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
name: PR ν…œν”Œλ¦Ώ
about: PR 날릴 λ•Œ μ‚¬μš©ν•˜μ‹œλ©΄ λ©λ‹ˆλ‹€.
title: ''
labels: ''
assignees: ''

---

## πŸ“ PR κ°œμš”

> 이 PRμ—μ„œ μ–΄λ–€ 변경이 μ΄λ£¨μ–΄μ‘ŒλŠ”μ§€ κ°„λž΅νžˆ μ„€λͺ…ν•΄μ£Όμ„Έμš”.
> 예: "둜그인 νŽ˜μ΄μ§€ UI κ°œμ„  및 닀크 λͺ¨λ“œ μΆ”κ°€"
---

## πŸ” λ³€κ²½ 사항

> PRμ—μ„œ λ³€κ²½λœ μ£Όμš” λ‚΄μš©μ„ ꡬ체적으둜 μ„€λͺ…ν•΄μ£Όμ„Έμš”.
> - 둜그인 νŽ˜μ΄μ§€μ˜ λ ˆμ΄μ•„μ›ƒμ„ μˆ˜μ •ν•˜μ—¬ μ‚¬μš©μž κ²½ν—˜ κ°œμ„ 
> - 닀크 λͺ¨λ“œ κΈ°λŠ₯ μΆ”κ°€ 및 μƒνƒœ 관리 둜직 κ΅¬ν˜„
> - ν…ŒμŠ€νŠΈ μ½”λ“œ μΆ”κ°€λ‘œ 닀크 λͺ¨λ“œ κΈ°λŠ₯ 검증
---

**μ„€λͺ…**: 이 ν•­λͺ©μ—μ„œλŠ” μ½”λ“œμ˜ μ£Όμš” λ³€κ²½ 사항을 λ‚˜μ—΄ν•˜μ—¬ 리뷰어가 μ½”λ“œ μˆ˜μ •μ˜ λͺ©μ μ„ μ‰½κ²Œ νŒŒμ•…ν•  수 μžˆλ„λ‘ ν•©λ‹ˆλ‹€. λ³€κ²½λœ μ£Όμš” λ‘œμ§μ΄λ‚˜ UI μˆ˜μ • 사항이 μžˆλ‹€λ©΄ ꡬ체적으둜 μ„€λͺ…ν•©λ‹ˆλ‹€.

---

## βœ… 체크리슀트 (Checklist)

- [ ] μ½”λ“œκ°€ λΉŒλ“œ 였λ₯˜ 없이 잘 μž‘λ™ν•˜λŠ”μ§€ 확인
- [ ] ν…ŒμŠ€νŠΈκ°€ ν†΅κ³Όν•˜λŠ”μ§€ 확인
- [ ] μŠ€νƒ€μΌ κ°€μ΄λ“œμ™€ 일관성을 μœ μ§€ν–ˆλŠ”μ§€ 확인
- [ ] κ΄€λ ¨ λ¬Έμ„œκ°€ μ—…λ°μ΄νŠΈλ˜μ—ˆλŠ”μ§€ 확인 (선택 사항)
- [ ] 리뷰어가 이해할 수 μžˆλ„λ‘ μ£Όμ„μ΄λ‚˜ μ„€λͺ…을 μΆ”κ°€ν–ˆλŠ”μ§€ 확인

---

**μ„€λͺ…**: 이 μ²΄ν¬λ¦¬μŠ€νŠΈλŠ” PR μž‘μ„±μžκ°€ 슀슀둜 점검할 수 μžˆλŠ” 기쀀을 μ œμ‹œν•©λ‹ˆλ‹€. μ½”λ“œκ°€ λΉŒλ“œ 였λ₯˜ 없이 μž‘λ™ν•˜κ³ , ν…ŒμŠ€νŠΈλ₯Ό ν†΅κ³Όν•˜λ©°, μŠ€νƒ€μΌ κ°€μ΄λ“œλ₯Ό λ”°λ₯΄κ³  μžˆλŠ”μ§€ ν™•μΈν•˜λŠ” ν•­λͺ©λ“€μž…λ‹ˆλ‹€.

---

## πŸ”„ κ΄€λ ¨ 이슈 (Linked Issues)

> 이 PRκ³Ό κ΄€λ ¨λœ 이슈 번호λ₯Ό μ μ–΄μ£Όμ„Έμš”. (예: #123)
> 예: "닀크 λͺ¨λ“œ κΈ°λŠ₯ μš”μ²­ 이슈(#45) ν•΄κ²°"
---

**μ„€λͺ…**: 이 PRκ³Ό κ΄€λ ¨λœ 이슈 번호λ₯Ό λ§ν¬ν•˜μ—¬ 리뷰어가 κ΄€λ ¨λœ λ¬Έμ œλ‚˜ μš”μ²­ 사항을 μ‰½κ²Œ μ°Έκ³ ν•  수 μžˆλ„λ‘ ν•©λ‹ˆλ‹€. 이λ₯Ό 톡해 μ΄μŠˆμ™€ PR을 μ—°κ²°ν•˜μ—¬ μž‘μ—…μ˜ λͺ©μ μ„ λͺ…ν™•νžˆ ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

---

## πŸ“· μŠ€ν¬λ¦°μƒ· 및 λ™μ˜μƒ (선택 사항)

> UI λ³€κ²½ 사항이 μžˆλŠ” 경우 μŠ€ν¬λ¦°μƒ·μ΄λ‚˜ λ™μ˜μƒμ„ μ²¨λΆ€ν•΄μ£Όμ„Έμš”.
> 예: λ³€κ²½λœ 둜그인 νŽ˜μ΄μ§€ ν™”λ©΄ 캑처
---

**μ„€λͺ…**: UI λ³€κ²½ 사항이 ν¬ν•¨λœ 경우, λ³€κ²½λœ 화면을 μ‹œκ°μ μœΌλ‘œ 보여주기 μœ„ν•΄ μŠ€ν¬λ¦°μƒ·μ΄λ‚˜ λ™μ˜μƒμ„ μ²¨λΆ€ν•˜λ©΄ 도움이 λ©λ‹ˆλ‹€. λ¦¬λ·°μ–΄λŠ” ν™”λ©΄ λ³€κ²½ 사항을 λ°”λ‘œ 확인할 수 μžˆμ–΄ μ½”λ“œ 리뷰가 더 νš¨κ³Όμ μž…λ‹ˆλ‹€.

---

## πŸ§ͺ ν…ŒμŠ€νŠΈ 방법

> λ³€κ²½ 사항을 κ²€ν† ν•  λ•Œ μ–΄λ–»κ²Œ ν…ŒμŠ€νŠΈν•΄μ•Ό ν•˜λŠ”μ§€ λ‹¨κ³„λ³„λ‘œ μ„€λͺ…ν•΄μ£Όμ„Έμš”.
> 예:
> 1. 둜그인 νŽ˜μ΄μ§€λ‘œ μ΄λ™ν•©λ‹ˆλ‹€.
> 2. 닀크 λͺ¨λ“œ μŠ€μœ„μΉ˜λ₯Ό ν΄λ¦­ν•©λ‹ˆλ‹€.
> 3. 배경색이 닀크 λͺ¨λ“œλ‘œ λ³€κ²½λ˜λŠ”μ§€ ν™•μΈν•©λ‹ˆλ‹€.
---

**μ„€λͺ…**: μ½”λ“œ λ³€κ²½ 사항을 κ²€ν† ν•  λ•Œ μ‚¬μš©ν•  ν…ŒμŠ€νŠΈ 방법을 ꡬ체적으둜 μ„€λͺ…ν•˜μ—¬, 리뷰어가 μ‰½κ²Œ ν…ŒμŠ€νŠΈλ₯Ό μˆ˜ν–‰ν•  수 μžˆλ„λ‘ ν•©λ‹ˆλ‹€. νŠΉμ • κΈ°λŠ₯μ΄λ‚˜ UI μš”μ†Œμ— λŒ€ν•œ ν…ŒμŠ€νŠΈ 방법을 μ•ˆλ‚΄ν•˜λ©΄ μ½”λ“œ 리뷰 속도가 λΉ¨λΌμ§‘λ‹ˆλ‹€.

---

## πŸ“š μ°Έκ³  자료 (선택 사항)

> PRκ³Ό κ΄€λ ¨λœ μ°Έκ³  μžλ£Œκ°€ μžˆλ‹€λ©΄ λ§ν¬λ‚˜ μ„€λͺ…을 μ²¨λΆ€ν•΄μ£Όμ„Έμš”.
> 예: "닀크 λͺ¨λ“œ κ΅¬ν˜„μ„ μœ„ν•œ 라이브러리 μ‚¬μš© κ°€μ΄λ“œ 링크"
---

**μ„€λͺ…**: μ°Έκ³ ν•  μžλ£Œκ°€ μžˆλ‹€λ©΄ 여기에 적어 리뷰어가 ν•„μš”ν•œ 경우 ν•΄λ‹Ή 자료λ₯Ό μ°Έμ‘°ν•  수 있게 ν•©λ‹ˆλ‹€. μ™ΈλΆ€ λΌμ΄λΈŒλŸ¬λ¦¬λ‚˜ μ°Έκ³ ν•  λ¬Έμ„œ, API λͺ…μ„Έ 링크 등이 포함될 수 μžˆμŠ΅λ‹ˆλ‹€.

0 comments on commit 296e995

Please sign in to comment.