Backend Wiki - 100-hours-a-week/6-nemo-wiki GitHub Wiki

ํ”„๋กœ์ ํŠธ ์ด๋ฆ„ Backend Wiki

Backend Repository

์„ค๊ณ„

[ERD ์„ค๊ณ„ - WIKI ๋ฐ”๋กœ๊ฐ€๊ธฐ]

ERD ์„ค๊ณ„ - ํ…Œ์ด๋ธ” ์ •์˜์„œ ๋ฐ”๋กœ๊ฐ€๊ธฐ

ERD ์„ค๊ณ„ - ERD CLOUD ๋ฐ”๋กœ๊ฐ€๊ธฐ

API ์„ค๊ณ„ - Excel ๋ฐ”๋กœ๊ฐ€๊ธฐ

๊ธฐ์ˆ  ์Šคํƒ ์„ ์ • - Notion ๋ฐ”๋กœ๊ฐ€๊ธฐ


๋ชฉ์ฐจ


๊ฐœ๋ฐœ ์ผ์ •

๊ธฐ๊ฐ„ ์ฃผ์š” ์ž‘์—…
MM/DD ~ ์ž‘์—… ๋‚ด์šฉ ์ž‘์„ฑ

์ปจ๋ฒค์…˜ ๋ฃฐ

1. ์ฝ”๋“œ ์Šคํƒ€์ผ ๊ฐ€์ด๋“œ

์˜ˆ์‹œ

  1. EditorConfig ์„ค์ •
์„ค์ • ํ•ญ๋ชฉ ๊ฐ’ ์„ค๋ช…
charset utf-8
end_of_line lf
indent_style space
insert_final_newline true
trim_trailing_whitespace true
max_line_length 120

2. CheckStyle ์„ค์ •

์˜ˆ์‹œ

ํ•ญ๋ชฉ ๊ทœ์น™
ํด๋ž˜์Šค๋ช…
๋ณ€์ˆ˜๋ช… ๋ฐ ๋ฉ”์„œ๋“œ๋ช…
์ƒ์ˆ˜๋ช…
ํŒจํ‚ค์ง€๋ช…
ํƒญ ์‚ฌ์šฉ
์ค„ ๋ฐ”๊ฟˆ
์ตœ๋Œ€ ๋ผ์ธ ๊ธธ์ด
์ œ์–ด๋ฌธ ๋ธ”๋ก {}
์—ฐ์‚ฐ์ž ๋ฐฐ์น˜
import ์ˆœ์„œ
์ฃผ์„ ์Šคํƒ€์ผ

3. ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์ปจ๋ฒค์…˜

์˜ˆ์‹œ


** ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋Š” type: message ํ˜•์‹์„ ๋”ฐ๋ฅด๋ฉฐ, ์•„๋ž˜์˜ ๊ทœ์น™์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค. **

์ œ๋ชฉ ๊ทœ์น™

  • ์ œ๋ชฉ์€ ๋‹ค์Œ ๋Œ€์†Œ๋ฌธ์ž ์Šคํƒ€์ผ ์ค‘ ํ•˜๋‚˜๋ฅผ ๋”ฐ๋ผ์•ผ ํ•ฉ๋‹ˆ๋‹ค:
    • sentence-case
    • start-case
    • pascal-case
    • upper-case
    • lower-case
  • ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.)๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
  • ์ œ๋ชฉ์€ ์ตœ์†Œ 5์ž ์ด์ƒ์ด์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
  • ์ „์ฒด ํ—ค๋”๋Š” 72์ž๋ฅผ ์ดˆ๊ณผํ•˜์ง€ ์•Š์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค.
ํƒ€์ž… ์„ค๋ช…
build
chore
content
docs
feat
fix
refactor
style
test
deploy

์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ํ˜•์‹

type: ์ œ๋ชฉ (#์ด์Šˆ๋ฒˆํ˜ธ)

๋ณธ๋ฌธ (์„ ํƒ ์‚ฌํ•ญ)

์˜ˆ์‹œ

feat: ๊ธฐ๋Šฅ ์š”์•ฝ (#์ด์Šˆ๋ฒˆํ˜ธ)

๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ๊ฐ„๋‹จํ•œ ์„ค๋ช… ์ถ”๊ฐ€

4. ์ถ”๊ฐ€ ๊ทœ์น™

์˜ˆ์‹œ

  • PR ์ œ๋ชฉ์€ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€์™€ ๋™์ผํ•œ ํ˜•์‹์„ ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค.
  • ํ•œ ๋ฒˆ์˜ PR์€ ํ•˜๋‚˜์˜ ๋ชฉ์ ์„ ๊ฐ€์ ธ์•ผ ํ•ฉ๋‹ˆ๋‹ค.
  • ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋ฅผ ๊ฑฐ์นœ ํ›„ ๋ณ‘ํ•ฉ์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.

์ด ์ปจ๋ฒค์…˜์„ ์ค€์ˆ˜ํ•˜์—ฌ ํŒ€์˜ ์ฝ”๋“œ ํ’ˆ์งˆ์„ ์œ ์ง€ํ•˜๊ณ  ์›ํ™œํ•œ ํ˜‘์—…์„ ์ง„ํ–‰ํ•ฉ์‹œ๋‹ค!


ํŠธ๋Ÿฌ๋ธ” ์ŠˆํŒ…


ERD

ERD Link [ERD ํ…Œ์ด๋ธ” ์ •์˜์„œ] https://www.notion.so/1d5e6294970680d2b81df44717e25568


API

  1. [API ์ธ์ฆ ํ๋ฆ„](API ์ธ์ฆ ํ๋ฆ„ ๋งํฌ)
  2. [API ์‘๋‹ต ๊ทœ๊ฒฉ](์‘๋‹ต ๊ทœ๊ฒฉ ๋งํฌ)
  3. [์—๋Ÿฌ ๋ฉ”์„ธ์ง€ ๋ชฉ๋ก](์—๋Ÿฌ ๋ชฉ๋ก ๋งํฌ)

๋ฐฐํฌ ํ™˜๊ฒฝ ๋ฐ CI/CD ํŒŒ์ดํ”„๋ผ์ธ

๊ด€๋ จ ๊ตฌ์„ฑ ๋ฐ ํŒŒ์ดํ”„๋ผ์ธ ์„ค๋ช… ์ž‘์„ฑ


์ฝ”๋“œ ํ’ˆ์งˆ ๊ด€๋ฆฌ ๋„๊ตฌ

์˜ˆ์‹œ

๋„๊ตฌ ์—ญํ•  ๋ชฉ์ 
.editorconfig
Checkstyle
JaCoCo
Java Test Fixtures
SonarQube
โš ๏ธ **GitHub.com Fallback** โš ๏ธ