Skip to content

Commit

Permalink
docs: update PULL_REQUEST_TEMPLATE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nxnaxx authored Nov 23, 2024
1 parent fbad2ea commit 9173e45
Showing 1 changed file with 47 additions and 10 deletions.
57 changes: 47 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,53 @@
## ๐Ÿ” PR ๊ฐœ์š”
PR์˜ ์ฃผ์š” ๋ชฉ์ ๊ณผ ๋ณ€๊ฒฝ ์‚ฌํ•ญ์— ๋Œ€ํ•ด ๊ฐ„๋‹จํžˆ ์„ค๋ช…ํ•ด ์ฃผ์„ธ์š”.

### ์—ฐ๊ฒฐ๋œ issue ๐ŸŒŸ
ex) ์—ฐ๊ฒฐ๋œ issue๋ฅผ ์ž๋™์œผ๋กœ ๋‹ซ๊ธฐ ์œ„ํ•ด # ๋‹ค์Œ ์ด์Šˆ ๋„˜๋ฒ„๋ฅผ ์ž…๋ ฅํ•ด์ฃผ์„ธ์š”. ex) #2
<br>
- closed #
</br>

### ๊ตฌํ˜„ ๋‚ด์šฉ ๐Ÿ“ข
ex) ๋กœ๊ทธ์ธ ์‹œ, ๊ตฌ๊ธ€ ์†Œ์…œ ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ–ˆ์Šต๋‹ˆ๋‹ค.
## โœจ PR Type
<!--ํ•ด๋‹น ํ•ญ๋ชฉ์— X๋ฅผ ์ถ”๊ฐ€ํ•˜์„ธ์š”.-->

- [ ] ๊ธฐ๋Šฅ ๊ตฌํ˜„
- [ ] ๋ฒ„๊ทธ ์ˆ˜์ •
- [ ] ์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ(๊ฐ€๋…์„ฑ ํ–ฅ์ƒ)
- [ ] ๋ฆฌํŒฉํ† ๋ง(์„ฑ๋Šฅ ์ตœ์ ํ™”, ๋ชจ๋“ˆํ™”, ์ค‘๋ณต ์ฝ”๋“œ ์ œ๊ฑฐ ๋“ฑ)
- [ ] ๋นŒ๋“œ ๊ด€๋ จ ๋ณ€๊ฒฝ
- [ ] ๋ฌธ์„œ ๋‚ด์šฉ ๋ณ€๊ฒฝ
- [ ] UI/UX ๊ฐœ์„ 
- [ ] ๊ธฐํƒ€:

### ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ ๐Ÿงฉ
ex) ๋ฒ ์ด์Šค ๋ธŒ๋žœ์น˜์— ํฌํ•จ๋˜๊ธฐ ์œ„ํ•œ ์ฝ”๋“œ๋Š” ๋ชจ๋‘ ์ •์ƒ์ ์œผ๋กœ ๋™์ž‘ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ๊ณผ๋ฌผ์— ๋Œ€ํ•œ ์Šคํฌ๋ฆฐ์ƒท, GIF, ํ˜น์€ ๋ผ์ด๋ธŒ ๋ฐ๋ชจ๊ฐ€ ๊ฐ€๋Šฅํ•˜๋„๋ก ์ƒ˜ํ”ŒAPI๋ฅผ ์ฒจ๋ถ€ํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.
</br>

## ๐Ÿ“‹ ๋ณ€๊ฒฝ ์‚ฌํ•ญ
- ์ฃผ์š” ๋ณ€๊ฒฝ ์‚ฌํ•ญ์„ ์š”์•ฝํ•˜์—ฌ ์ ์–ด์ฃผ์„ธ์š”.
- ์˜ˆ: ์ƒˆ๋กœ์šด ์ปดํฌ๋„ŒํŠธ ์ถ”๊ฐ€, ์Šคํƒ€์ผ ์ˆ˜์ • ๋“ฑ

### ๋ฆฌ๋ทฐ ํฌ์ธํŠธ ๐Ÿ“Œ
ex) ์ค‘์ ์œผ๋กœ ๋ด์•ผํ• ๋งŒํ•œ ํฌ์ธํŠธ๋‚˜, ๋…ผ์˜ ํ•˜๊ณ  ์‹ถ์€ ํฌ์ธํŠธ๊ฐ€ ์žˆ๋‹ค๋ฉด ์ ์–ด์ฃผ์„ธ์š”!
</br>

## ๐Ÿ›  ์ƒ์„ธ ์ž‘์—… ๋‚ด์—ญ
- [ ] ์ž‘์—… ๋‚ด์—ญ 1 (์˜ˆ: "Button ์ปดํฌ๋„ŒํŠธ ์Šคํƒ€์ผ ์ˆ˜์ •")
- [ ] ์ž‘์—… ๋‚ด์—ญ 2 (์˜ˆ: "Header ์ปดํฌ๋„ŒํŠธ ๋ฆฌํŒฉํ† ๋ง")
- [ ] ๊ธฐํƒ€

</br>

## โœ… ์ฒดํฌ๋ฆฌ์ŠคํŠธ
- [ ] ์ฝ”๋“œ๊ฐ€ ์˜ˆ์ƒ๋Œ€๋กœ ๋™์ž‘ํ•˜๋Š”์ง€ ํ™•์ธ
- [ ] ๊ด€๋ จ ํ…Œ์ŠคํŠธ๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ํ†ต๊ณผํ–ˆ๋Š”์ง€ ํ™•์ธ
- [ ] UI/UX ๋ณ€๊ฒฝ ์‚ฌํ•ญ์ด ์ผ๊ด€๋˜๊ฒŒ ์ ์šฉ๋˜์—ˆ๋Š”์ง€ ํ™•์ธ
- [ ] ๋ฌธ์„œ๊ฐ€ ์ตœ์‹  ์ƒํƒœ๋กœ ์œ ์ง€๋˜์—ˆ๋Š”์ง€ ํ™•์ธ (์˜ˆ: Storybook, README)

</br>

## ๐Ÿ“ธ ์Šคํฌ๋ฆฐ์ƒท (์„ ํƒ ์‚ฌํ•ญ)
UI ๋ณ€๊ฒฝ ์‚ฌํ•ญ์ด ์žˆ๊ฑฐ๋‚˜ ํ…Œ์ŠคํŠธ ๊ด€๋ จ ์Šคํฌ๋ฆฐ์ƒท์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ ์ถ”๊ฐ€ํ•ด ์ฃผ์„ธ์š”.

</br>

## โš ๏ธ ์ฃผ์˜ ์‚ฌํ•ญ
- ์ฝ”๋“œ ๋ฆฌ๋ทฐ ์‹œ ํŠนํžˆ ์ฃผ์˜ํ•ด์•ผ ํ•  ์‚ฌํ•ญ์ด๋‚˜ ์ฐธ๊ณ ํ•  ์‚ฌํ•ญ์ด ์žˆ๋‹ค๋ฉด ์ž‘์„ฑํ•ด ์ฃผ์„ธ์š”.
- ์˜ˆ: "ํŠน์ • ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์‚ฌ์šฉ ์ฃผ์˜", "์Šคํƒ€์ผ ์ถฉ๋Œ ๊ฐ€๋Šฅ์„ฑ ์žˆ์Œ" ๋“ฑ

</br>

## ๐Ÿ”— ๊ด€๋ จ ์ด์Šˆ
- ๊ด€๋ จ๋œ ์ด์Šˆ ๋ฒˆํ˜ธ๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”. ์˜ˆ: Closes #123

0 comments on commit 9173e45

Please sign in to comment.