Convention - NariP/modoo-todo GitHub Wiki
Workflow
1. ์ด์ ์์ฑ
- github repository์ ๊ฐ๋ฐํ ๋จ์์ ํด๋นํ๋ ์ด์๋ฅผ ์์ฑํ๋ค
- ์ด์ ์์ฑ ์ปจ๋ฒค์
2. ์ด์์ ๋ง๋ ๊ธฐ๋ฅ ๋ธ๋์น ์์ฑ
- Git-flow์ ๋ฐ๋ฅธ ๋ธ๋์น ๊ด๋ฆฌ ์ฐธ์กฐ. ์ฐ๋ฆฐ Git-flow๋ฅผ ์ฌ์ฉํ๊ณ ์์ด์
- ๋ธ๋์น ์์ฑ ์ปจ๋ฒค์
- feature/๊ธฐ๋ฅ์ด๋ฆ#(์ด์๋ฒํธ)
- e.g.
feature/todo#3
- ํด๋น ๋ธ๋์น์์ ์์
ํ๊ณ PR
3. Pull Request
- PR ์ ๋ชฉ์ commit ์ปจ๋ฒค์
ํ์๊ณผ ๋์ผ
- ์์
ํ ์ด์๋ฅผ closes๋ก ๋ซ๋๋ค.
- ์์
๋ด์ฉ์ ์ ๋๋ค.
- Labels, Assignees, Reviewers ๊น๋จน์ง ๋ง๊ณ ์ถ๊ฐํ๋ค.
- ์์ 1(์ฐ๊ฒฐ๋ ์ด์ ๋ฒํธ: 2)
feature: ๋ณธ๋ฌธ, ์ถ๊ฐ ๋ด์ฉ ์ปดํฌ๋ํธ ๊ฐ๋ฐ
### ์์
๋ด์ฉ
- ๊ฒ์๊ธ ๋ณธ๋ฌธ ์ปดํฌ๋ํธ ๊ฐ๋ฐ
- ๊ฒ์๊ธ ์ถ๊ฐ ๋ด์ฉ ์ปดํฌ๋ํธ ๊ฐ๋ฐ
- ๊ฒ์๊ธ ๋ ์ด์์ ๊ฐ๋ฐ
closes #2
Commit Message Guideline
type: Subject #(์ด์๋ฒํธ)
(๊ณต๋ฐฑ)
body
- ๐ก Subject, body ์ฒซ ๊ธ์๋ ๋๋ฌธ์
- ๐ก ํ๊ธ ์ฌ์ฉ ๊ฐ๋ฅ
- TYPE
- feat: ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ
- fix: ๋ฒ๊ทธ ์์
- design: CSS ๋ฑ ์ฌ์ฉ์ UI ๋์์ธ ๋ณ๊ฒฝ
- style: ์ฝ๋ ํฌ๋งท ๋ณ๊ฒฝ e.g. ์ธ๋ฏธ ์ฝ๋ก ๋๋ฝ
- refactor: ๋ฆฌํฉํ ๋ง
- docs: ๋ฌธ์๋ฅผ ์์