Backend Wiki - 100-hours-a-week/21-iceT-wiki GitHub Wiki

Koco Backend Wiki

Backend Repository


λͺ©μ°¨


개발 일정

κΈ°κ°„ μ£Όμš” μž‘μ—…
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

  1. ERD
  2. ν…Œμ΄λΈ” μ •μ˜μ„œ

API

API 섀계 λ¬Έμ„œ

  1. [API 인증 흐름](API 인증 흐름 링크)
  2. [API 응닡 규격](응닡 규격 링크)
  3. [μ—λŸ¬ λ©”μ„Έμ§€ λͺ©λ‘](μ—λŸ¬ λͺ©λ‘ 링크)

배포 ν™˜κ²½ 및 CI/CD νŒŒμ΄ν”„λΌμΈ

κ΄€λ ¨ ꡬ성 및 νŒŒμ΄ν”„λΌμΈ μ„€λͺ… μž‘μ„±


μ½”λ“œ ν’ˆμ§ˆ 관리 도ꡬ

μ˜ˆμ‹œ

도ꡬ μ—­ν•  λͺ©μ 
.editorconfig
Checkstyle
JaCoCo
Java Test Fixtures
SonarQube
⚠️ **GitHub.com Fallback** ⚠️