-
Notifications
You must be signed in to change notification settings - Fork 1
Commit Message and Branch Convention
Seungmin edited this page Oct 24, 2022
·
3 revisions
type: subject
body
footer
- Commit Type
Type | ์๋ฏธ |
---|---|
feat | ์๋ก์ด ๊ธฐ๋ฅ |
fix | ๋ฒ๊ทธ ์์ |
refactor | ๋ฆฌํฉํ ๋ง |
style | ์คํ์ผ |
docs | ๋ฌธ์ |
test | ํ ์คํธ |
chore | ๊ธฐํ ๋ณ๊ฒฝ์ฌํญ |
- Subject
- ์ ๋ชฉ์ ๋ช ๋ น์ด๋ก ์์ฑํ๋ค.
- ๋ง์นจํ๋ฅผ ๋ถ์ด์ง ์๋๋ค.
- ํ๊ธ ๋ฐ ์์ด ๋ชจ๋ ์ฌ์ฉ ๊ฐ๋ฅํ๋ค.
- Body (์ ํ)
- ๋ถ์ฐ ์ค๋ช ์ด๋ ์ปค๋ฐ์ ์ด์ ๋ฅผ ์์ฑํ๋ค.
- Footer (์ ํ)
- ์ฃผ๋ก ์ด์๋ฒํธ๋ฅผ ๋จ๊ธด๋ค.
ex) Issue: #00, Resolves: #00, See Also: #00, etc
๊ฐ๋ฐ์ ๊ฐ ํ์ ์์ ์ ์์ฑ๋ Commit Message ๋ ๊ต์ฅํ ์ ์ตํ๋ค.
Commit Log ์ ๊ฐ๋ ์ฑ์ ๋์ฌ์ฃผ๊ณ , ํ์ ๊ณผ ๋ฆฌ๋ทฐ ํ๋ก์ธ์ค์ ๋์์ ์ฃผ๋ฉฐ, ์ ์ง๋ณด์๋ฅผ ์กฐ๊ธ ๋ ์ฉ์ดํ๊ฒ ๋ง๋ค์ด ์ค๋ค.
์ข์ Commit Message ์ ์ ๋ต์ ์๊ณ , ๊ธฐ์ค ๋ํ ๋ชจ๋๊ฐ ๋ค๋ฅด์ง๋ง ์ฝ์์ ์ ํด์ ์์ฑํ๋ ๊ฒ์ ์ข์ ํจ๊ณผ๋ฅผ ๊ฐ์ ธ์ฌ ๊ฒ์ด๋ผ ์๊ฐ์ด ๋๋ค.
- master : ์ ํ์ผ๋ก ์ถ์๋ ์ ์๋ ๋ธ๋์น
- develop: ๋ค์ ์ถ์ ๋ฒ์ ์ ๊ฐ๋ฐํ๋ ๋ธ๋์น
- feature: ๊ธฐ๋ฅ์ ๊ฐ๋ฐํ๋ ๋ธ๋์น
์๋ ์๋๋ก์ด๋์์๋ develop ๋ธ๋์น๋ฅผ Default๋ก ํ๊ณ ์ฑ์ผ ๊ธฐ๊ฐ์๋ feature/๊ธฐ๋ฅ ๋ธ๋์น๋ฅผ ์ฌ์ฉํ๋ค.