Backend Wiki - 100-hours-a-week/KTB4-1st-wiki GitHub Wiki
| ๊ธฐ๊ฐ | ์ฃผ์ ์์ |
|---|---|
| MM/DD ~ | ์์ ๋ด์ฉ ์์ฑ |
์์
- EditorConfig ์ค์
| ์ค์ ํญ๋ชฉ | ๊ฐ | ์ค๋ช |
|---|---|---|
| charset | utf-8 | |
| end_of_line | lf | |
| indent_style | space | |
| insert_final_newline | true | |
| trim_trailing_whitespace | true | |
| max_line_length | 120 |
์์
| ํญ๋ชฉ | ๊ท์น |
|---|---|
| ํด๋์ค๋ช | |
| ๋ณ์๋ช ๋ฐ ๋ฉ์๋๋ช | |
| ์์๋ช | |
| ํจํค์ง๋ช | |
| ํญ ์ฌ์ฉ | |
| ์ค ๋ฐ๊ฟ | |
| ์ต๋ ๋ผ์ธ ๊ธธ์ด | |
| ์ ์ด๋ฌธ ๋ธ๋ก {} | |
| ์ฐ์ฐ์ ๋ฐฐ์น | |
| import ์์ | |
| ์ฃผ์ ์คํ์ผ |
์์
** ์ปค๋ฐ ๋ฉ์์ง๋ type: message ํ์์ ๋ฐ๋ฅด๋ฉฐ, ์๋์ ๊ท์น์ ๋ฐ๋ฆ ๋๋ค. **
์ ๋ชฉ ๊ท์น
- ์ ๋ชฉ์ ๋ค์ ๋์๋ฌธ์ ์คํ์ผ ์ค ํ๋๋ฅผ ๋ฐ๋ผ์ผ ํฉ๋๋ค:
- sentence-case
- start-case
- pascal-case
- upper-case
- lower-case
- ์ ๋ชฉ ๋์ ๋ง์นจํ(.)๋ฅผ ์ฌ์ฉํ์ง ์์ต๋๋ค.
- ์ ๋ชฉ์ ์ต์ 5์ ์ด์์ด์ด์ผ ํฉ๋๋ค.
- ์ ์ฒด ํค๋๋ 72์๋ฅผ ์ด๊ณผํ์ง ์์์ผ ํฉ๋๋ค.
| ํ์ | ์ค๋ช |
|---|---|
| build | ๋น๋ ์์คํ , ๋น๋ ์คํฌ๋ฆฝํธ, ํจํค์ง ๋งค๋์ ์ค์ ๋ฑ ๋น๋ ๊ด๋ จ ๋ณ๊ฒฝ |
| chore | ์ฝ๋ ๋ก์ง์ ์ํฅ ์๋ ์ก๋คํ ์์ (์ค์ ํ์ผ, ์์กด์ฑ ๋ฒ์ ์ ๋ฐ์ดํธ ๋ฑ) |
| content | ๋ฌธ์๊ฐ ์๋ ์ฝํ ์ธ ์ฑ ๋ฐ์ดํฐ ๋ณ๊ฒฝ (์ ์ ํ ์คํธ, ์ด๋ฏธ์ง, ์ด๊ธฐ ๋ฐ์ดํฐ ๋ฑ) |
| docs | ๋ฌธ์ ์ถ๊ฐ/์์ (README, API ๋ฌธ์, ์ฃผ์ ๋ฑ) |
| feat | ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ |
| fix | ๋ฒ๊ทธ ์์ |
| refactor | ๊ธฐ๋ฅ ๋ณ๊ฒฝ ์์ด ์ฝ๋ ๊ตฌ์กฐ ๊ฐ์ |
| style | ์ฝ๋ ํฌ๋งทํ , ์ธ๋ฏธ์ฝ๋ก , ๊ณต๋ฐฑ ๋ฑ ๋ก์ง์ ์ํฅ ์๋ ์คํ์ผ ๋ณ๊ฒฝ |
| test | ํ ์คํธ ์ฝ๋ ์ถ๊ฐ/์์ |
| deploy | ๋ฐฐํฌ ๊ด๋ จ ์ค์ ๋ฐ ์คํฌ๋ฆฝํธ ๋ณ๊ฒฝ (CI/CD, ๋ฐฐํฌ ํ๊ฒฝ ์ค์ ๋ฑ) |
type: ์ ๋ชฉ (#์ด์๋ฒํธ)
๋ณธ๋ฌธ (์ ํ ์ฌํญ)
์์
feat: ๊ธฐ๋ฅ ์์ฝ (#์ด์๋ฒํธ)
๊ธฐ๋ฅ์ ๋ํ ๊ฐ๋จํ ์ค๋ช
์ถ๊ฐ
์์
- PR ์ ๋ชฉ์ ์ปค๋ฐ ๋ฉ์์ง์ ๋์ผํ ํ์์ ์ ์งํฉ๋๋ค.
- ํ ๋ฒ์ PR์ ํ๋์ ๋ชฉ์ ์ ๊ฐ์ ธ์ผ ํฉ๋๋ค.
- ์ฝ๋ ๋ฆฌ๋ทฐ๋ฅผ ๊ฑฐ์น ํ ๋ณํฉ์ ์ํํฉ๋๋ค.
์ด ์ปจ๋ฒค์ ์ ์ค์ํ์ฌ ํ์ ์ฝ๋ ํ์ง์ ์ ์งํ๊ณ ์ํํ ํ์ ์ ์งํํฉ์๋ค!
- API ์ธ์ฆ ํ๋ฆ
- [API ์๋ต ๊ท๊ฒฉ](์๋ต ๊ท๊ฒฉ ๋งํฌ)
- [์๋ฌ ๋ฉ์ธ์ง ๋ชฉ๋ก](์๋ฌ ๋ชฉ๋ก ๋งํฌ)
๊ด๋ จ ๊ตฌ์ฑ ๋ฐ ํ์ดํ๋ผ์ธ ์ค๋ช ์์ฑ
์์
| ๋๊ตฌ | ์ญํ | ๋ชฉ์ |
|---|---|---|
| .editorconfig | ||
| Checkstyle | ||
| JaCoCo | ||
| Java Test Fixtures | ||
| SonarQube |