convention

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 : product code에 대한 testing~
• refactor : 코드 리펙토링!
• docs : 문서 정리!
• chore : compile과 상관없는 잡일!!

pull request

• 무엇을, 어떻게, 왜 -> 템플릿 적용하기
• 올릴 때 "resolves #{이슈번호}" 명시하기

Issue

• 무엇을, 어떻게, 왜 -> 템플릿 적용하기
• 이슈와 PR은 1대1로 관리

Merge 전략

• feature -> develop : 스쿼시 방식
• develop -> main : rebase 방식

Branch 전략

• main
  • develope
    • feature/#{이슈번호}-{기능명}

lombok

• getter
• allargs
• requiredargs
• builder
• equalsAndHashCode
• toString

Dto Validation

• Regex, Pattern 적극활용

URL member를 예시로~

Http Method	feat	url	etc
GET	조회	/api/v1/members /api/v1/members/{memberId}	-
POST	생성	/api/v1/members	-
PATCH	수정	/api/v1/members/{memberId}	-
PUT	수정	/api/v1/members/{memberId}	-
DELETE	삭제	/api/v1/members/{memberId}	-