| name | writing-pull-requests |
| description | Use when opening a pull request or writing a PR description in this repository |
PR ์์ฑ
PR ๋ณธ๋ฌธ์ diff์ ์๋ ์ฌ์ค๋ง ๋ด๋๋ค.
์ ๋ชฉ์ ์ปค๋ฐ ์ ๋ชฉ๊ณผ ๊ฐ์ [TYPE] ํ๊ตญ์ด ์์ฝ ํ์์ด๊ณ , base๋ develop์ด๋ค. ํ์ ์์ธ๋ writing-commits๋ฅผ ์ด๋ค.
๋ณธ๋ฌธ
.github/PULL_REQUEST_TEMPLATE.md์ ์น์
์ ๊ทธ๋๋ก ์ฑ์ด๋ค.
- ์๋ด์ฉ HTML ์ฃผ์(
<!-- ... -->)์ ์ง์ด๋ค. ๋ด์ฉ์ HTML ์ฃผ์ ์์ ์ฐ๋ฉด ๋ ๋๋ง๋์ง ์์ ๋น ์น์
์ด ๋๋ค.
- Changes๋ diff์ ์๋ ํ์ผยทํด๋์ค๋ง ํ ์ค์ฉ
- Related Issue๋ ์ด์ ๋ฒํธ๊ฐ ์์ ๋๋ง
Closes #N, ์์ผ๋ฉด ๋น์ด๋ค
- Notes๋ diff์ ๊ทผ๊ฑฐ๊ฐ ์๋ ์ฌ์ค๋ง โ ์ค์ ยทํ๊ฒฝ๋ณ์ ๋ณ๊ฒฝ, ์ด๋ฒ PR์์ ์๋์ ์ผ๋ก ๋จ๊ธด ํ๊ณ, ๋ฆฌ๋ทฐ์ด๊ฐ ์ง์คํด์ ๋ณผ ํ์ผ. ์์ผ๋ฉด ๋น์ด๋ค
์ฒดํฌ๋ฐ์ค๋ ํ์ธํ ๊ฒ๋ง
์ง์ ์คํํด์ ๊ฒฐ๊ณผ๋ฅผ ๋ณธ ํญ๋ชฉ๋ง [x]. ๋๋จธ์ง๋ [ ]๋ก ๋จ๊ธฐ๊ณ , ํ์ํ๋ฉด Notes์ ์ด์ ๋ฅผ ํ ์ค ์ด๋ค.
์
ํ ๋ฆฌ๋ทฐ์ ๋ถํ์ํ ์ฝ๋์ ๋ก๊ทธ๋ฅผ ์ ๊ฑฐํ์ต๋๋ค๋ diff๋ฅผ ๋๊น์ง ์ฝ์์ผ๋ฉด ์ฒดํฌํ๋ค โ ์คํ์ด ํ์ํ ํญ๋ชฉ์ด ์๋๋ค.
| ๋์ด๊ฐ๋ ค๋ ์๊ฐ | ์ฌ์ค |
|---|
| "์ด ์ ๋๋ฉด ๋ก์ปฌ์์ ๋๋ ค๋ดค์ ๊ฒ์ด๋ค" | ๋ด๊ฐ ์คํํ ๋ช
๋ น์ด ์์ผ๋ฉด ์ฒดํฌํ์ง ์๋๋ค |
| "์กฐ๊ฑด๋ถ ํญ๋ชฉ์ด๋ ํด๋น ์์ผ๋ฉด ์ฒดํฌํด๋ ๋๋ค" | ํด๋น ์์์ [ ]๋ค |
Red flags โ ๋ฉ์ถ๊ณ ๋ค์ ์ด๋ค:
- ์คํํ ์ ์๋ ํญ๋ชฉ์ด
[x]
- ๋ณธ๋ฌธ์ diff์ ์๋ ํด๋์คยทํ๋ยท๊ณํ์ด ๋ฑ์ฅ
์์ฑ
๋ณธ๋ฌธ์ ํ์ผ์ ์ฐ๊ณ ๋๊ธด๋ค.
gh pr create --base develop --title "[TYPE] ์์ฝ" --body-file pr-body.md
--body์ ๊ธด ๋งํฌ๋ค์ด์ ์ธ๋ผ์ธ์ผ๋ก ๋ฃ์ผ๋ฉด ์
ธ ์ด์ค์ผ์ดํ์์ ๊นจ์ง๋ค.