ํ ๋ช : A4์ฉ์ง
ํ๋ก์ ํธ ๋ช : AVOCADO
ํ์ : ํฉ์์, ์ ์ฐ์, ์ค์น๊ธฐ, ์ด์ํฌ, ์ ์ฌํ, ๊ถ๋ฏผ์ฌ
๋ฐฐํฌ ๋งํฌ : [์๋ณด์นด๋ ๊ฒฝ๋งค](https://i9a407.p.ssafy.io)
์๋ฌด๊ฑฐ๋
๋ณด์ฌ์ฃผ๊ณ
์นด๋ฉ๋ผ๋ก ํ๋งคํ๋
๋๋ผ๊ธฐ๊ฒฝ๋งค
`๊ฒฝ๋งค` ๊ฑฐ๋๋ฐฉ์์ ๋ฉ์ธ์ผ๋ก ์ก์ ์๋น์ค๋ก, ์ด์ฉ์์ ๋ฌผ๊ฑด์ ๋ฑ๋กํ๊ณ `๋ผ์ด๋ธ๊ฒฝ๋งค`์ `์์๊ฒฝ๋งค`๋ฅผ ํตํด ์ด์ฉ์๋ ๋ค์ํ ์ํ์ ์ ์ ํ ๊ฐ๊ฒฉ์ผ๋ก ๊ตฌ๋งคํ ์ ์์ต๋๋ค.
ํฉ์์ | ์ ์ฐ์ | ์ค์น๊ธฐ | ์ด์ํฌ | ์ ์ฌํ | ๊ถ๋ฏผ์ฌ |
---|---|---|---|---|---|
ํ์คํ ์ดํดํ๋ฉด์ ์งํํ์! |
๋ชจ๋ฅด๋ ๊ฑด ์ตํ๊ณ , ํ ์ ์๋ ๊ฑด ์ต์ ! |
๋ง์ธ๋๋ ์ค๋ ฅ๋ ์ฑ์ฅ! |
ํญ์ ๊ธ์ ์ ์ผ๋ก ์ต์ ์ ๋คํ์! |
๋ฏธ๋ฆฌ ํ๊ธฐ! | โ๊ทธ๋ฅโ ์ด๋ผ ํ์ง ์๊ธฐ |
- ์์ธ๋ฅผ ๋ฐํํ๋ ๊ฒฝ์ฐ ๋์ OrElseThrow ๋ถ์ ex) ์ฌ์ฉ์ ๋ช ์ ์ฐพ๋๋ฐ ์์ผ๋ฉด ์์ธ๋ฅผ ๋ฐํํ๋ ๊ฒฝ์ฐ findMemberOrElseThrow ๋ผ๊ณ ๋ถ์
- cancle๊ฐ์ด ์์ธ ๋ฐํ์ด ๋ช ํํ ๊ฒฝ์ฐ์ ์๋ตํด๋ ๊ด์ถ
- final or static ์ด ๋ถ๋ ๋ณ์๋ช
์
๋๋ฌธ์
๋ก ์์ฑ, ๊ณต๋ฐฑ์ด ํ์ํ๋ฉด_
์ฌ์ฉ - ๊ทธ ์ธ์
Camel Case
์ฌ์ฉ
- ๋ชจ๋ ํญ๋ชฉ์
๋๋ฌธ์
๋ก ๊ตฌ์ฑ - ๊ฐ ์์ ์๋ณ์๋ ์ ์๊ฐ ์๋
**๋ฌธ์์ด**
๋ก ํ๋ค.
- domain๊ณผ repository๋ ๊ฐ์ ํจํค์ง์ ๋ฃ์
Git-Flow ๋ธ๋์น ์ ๋ต์ ๋ฐ๋ผ ๊ธฐ๋ฅ๋ณ๋ก ๋ธ๋์น๋ฅผ ๋๋์ด ์์
ํ๊ณ ์๊ณ ๋ชจ๋ ๋ธ๋์น์ ๋ํด pull request๋ฅผ ํตํ ๋ฆฌ๋ทฐ ์๋ฃ ํ Merge๋ฅผ ํ๊ณ ์์ต๋๋ค.
โ master : ์ ํ์ผ๋ก ์ถ์๋ ์ ์๋ ๋ธ๋์น
โ develop : ๋ค์ ์ถ์ ๋ฒ์ ์ ๊ฐ๋ฐํ๋ ๋ธ๋์น. feature์์ ๋ฆฌ๋ทฐ์๋ฃํ ๋ธ๋์น๋ฅผ Merge
โ feature : ๊ธฐ๋ฅ์ ๊ฐ๋ฐํ๋ ๋ธ๋์น
โ hotfix : ์ถ์ ๋ฒ์ ์์ ๋ฐ์ํ ๋ฒ๊ทธ๋ฅผ ์์ ํ๋ ๋ธ๋์น
์ฐธ๊ณ ๋ฌธํ
Karma - Git Commit Msg
- ๊ธฐ๋ฅ ํ๋๋น ํ๋์ ๋ธ๋์น์ ์์
- ์ฆ,
ํ ์ฌ๋๋น ํ ๋ธ๋์น
๋ฅผ ์ฌ์ฉ - ์ํฉ์ ๋ฐ๋ผ
์ค๊ฐ ๋ธ๋์น
๋ฅผ ๋๊ณ ๊ทธ๊ณณ์ ๋ณํฉํ ์ ์์ - ๋ธ๋์น ๋ค์ด๋ฐ์
์ผ๋ฐฅ ์ผ์ด์ค
์ฌ์ฉ ex) ๋ฐฉ์ก์ ์ฑํ ํผ์ณ๋ฅผ ๋งก์ ๊ฒฝ์ฐ feature-live-chatting - develop์ ๊ฒฝ์ฐ ๋ฐฑ, ํ๋ก ํธ ๊ตฌ๋ถ์ ์ํด backend/develop, frontend/develop ์์ผ๋ก ๊ตฌํ - ๊ฐ FEATURE๋ค์ ์ค๊ฐ ๋ธ๋์น ๋๋ DEVELOP ๋ธ๋์น์
์ค์ฟผ์ ๋จธ์ง
ํ ์๋ก์ด ๋ธ๋์น ์์ฑ
- ๋จธ์ง conflict ๋ฐ์์, ๋ณํฉ ์ง์ ์ถฉ๋ ๋ ๋ ์ค๊ฐ ๋ธ๋์น ๋๋ DEVELOP์๋ค ํ๋ฉด ์ปค๋ฐ ๋ก๊ทธ๊ฐ ์ง์ ๋ถํด์ง
์ค์ฟผ์ ๋จธ์ง
ํ๋ธ๋์น ์ญ์
- ๋ธ๋์น ๋ค์ด๋ฐ์
์ผ๋ฐฅ ์ผ์ด์ค
์ฌ์ฉ
- ๊ธํ๊ฒ ์์ ํ ์ผ์ด ์์ ๋ ์ฌ์ฉ
์ค์ฟผ์ ๋จธ์ง
ํ๋ธ๋์น ์ญ์
- ๋ธ๋์น ๋ค์ด๋ฐ์
์ผ๋ฐฅ ์ผ์ด์ค
์ฌ์ฉ
EX) ์ฑํ ๊ธฐ๋ฅ ๊ตฌํ์ Feat: ์ฑํ ๊ธฐ๋ฅ ๊ตฌํ ํ์์ 1~2์ค ์ ๋์ ์ถ๊ฐ ๋ฉ์์ง ๋ฌ ์ ์๋ค.
- ์๋ก์ด ๊ธฐ๋ฅ์ด ์ถ๊ฐ๋ ๋
- readme, swagger, ์ฃผ์๊ฐ์ด ๋ฌธ์ํ์ ๊ด๋ จ๋ ๋ชจ๋ ์์
- ํฌ๋งทํ , ์ฝ๋ ์ปจ๋ฒค์ ๊ฐ์ด ๋ก์ง์ด ๋ฐ๋์ง ์์ ์์ ์์
- ์ฝ๋ ๋ก์ง ์ฌ๊ตฌ์ฑ๊ณผ ๊ด๋ จ๋ ๋ชจ๋ ์์
- ์ฌ์ํ ์ปค๋ฐ ex) Chore: ์ ์ฌ ๋จน๊ธฐ ์ ์ปค๋ฐ
- test ์ฝ๋ ์์ฑ๊ณผ ๊ด๋ จ๋ ๋ชจ๋ ์์
- ๋ฌธ์ํ๋ฅผ ํตํ ํ์
- PR ๊ณผ์ ์์ ๋ฐ์ํ๋ conflict ํด๊ฒฐ ๋ฐ ํ์ ๋ฅ๋ ฅ ํฅ์
- Spring Boot๋ฅผ ํ์ฉํด ์ฃผ์ด์ง ์๊ตฌ์ ๋ง์ถฐ REST API ์ค๊ณ ๋ฐ ๊ตฌํ
- ์ฃผ์ด์ง ์๊ตฌ์ ๋ง์ถฐ ERD ์ค๊ณ