Skip to content

convention

DongGeon0908 edited this page Oct 21, 2021 · 12 revisions

Coding Conventions

Naming Rule

  • Java Naming 전략을 따르기!
  • controller는 도메인에서 쓰는 동사형 쓰기
  • service는 create, update, delete
  • repository는 jpa 네이밍 규칙 따르기
  • 전치사 to, as, from, has 많이 쓰기!

Layer Rule

  • domain
    • service
    • controller
    • converter
    • dto
      • request
      • response
    • entity
    • repository

cleanCode

  1. 한 메서드에 오직 한 단계의 들여쓰기만 한다.
  2. else 예약어를 쓰지 않는다.
  3. 모든 원시 값과 문자열을 포장한다.
  4. 한 줄에 점을 하나만 찍는다.
  5. 줄여 쓰지 않는다(축약 금지).
  6. 모든 엔티티를 작게 유지한다.
  7. 3개 이상의 인스턴스 변수를 가진 클래스를 쓰지 않는다.
  8. 일급 컬렉션을 쓴다.
  9. getter/setter/프로퍼티를 쓰지 않는다.

commit rule

  • fix :
  • feat :
  • hotfix :
  • test :
  • refactor :
  • docs :
  • chore :

pull request

  • 무엇을, 어떻게, 왜

Issue

  • 무엇을, 어떻게, 왜
Clone this wiki locally