Search
📂

YJPD Convention

Code Convention

Entity
setter 사용 금지
메소드 사용 금지
객체간 변환 작업
org.mapstruct.Mapper 사용
implementation 'org.mapstruct:mapstruct:1.5.3.Final' annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'
Shell
복사
Custom ResultCode 사용
Custom ResponseEntity 사용
api 1개당 dto 1개씩 (req, res)
네이밍 규칙
dto
request: Req
response: Res
메소드명: 무슨 일을 하는 메소드인지 이해될 정도면 됨

Commit Convention

Feat : 새로운 기능을 추가하는 경우
Fix : 버그를 고친경우
Docs : 문서를 수정한 경우
Style : 코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는경우
Refactor : 코드 리팩토링
Test: 테스트 코드 작성

Code Style

GoogleStyle