-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #98 from boostcampwm-2024/Docs-1
[ENV][Docs] #1 : PR ν νλ¦Ώ μμ±
- Loading branch information
Showing
1 changed file
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 λͺ μΈ λ§ν¬ λ±μ΄ ν¬ν¨λ μ μμ΅λλ€. |