[11월 26일 화요일] 팀 규칙 및 컨벤션 정리 - gae-jang-mo/app GitHub Wiki

팀 규칙

  • 지각 시, 5000원씩 장부에 기록한다. 지각의 기준은 오전 10시 00분에 책상에 앉아있어야 한다.
  • 매일 오후 5시에 코드 리뷰를 진행한다. PR은 보내고 싶을 때 보내고, 자기 분담이 끝나면 다른 사람들 코드 보면서 코멘트 남기는 방식으로
  • 팀 간 이견 발생 시 해결 방식: 시간을 정해놓고 차차 맞춰가자.

컨벤션

1. 브랜치명

2. 클래스명

  • 첫 줄 개행: 어노테이션이 있으면 하고 없으면 붙인다
  • final을 어디까지 붙일 것인가
    • 필드
    • 파라미터
  • String 관련 Util 클래스 만들기 (ex - isBlank(), isNull() )

3. 메서드명

  • Controller 레이어
  • DTO 클래스명은 ‘블라블라 + Dto’라고 붙여쓴다.
  • DTO 변환은 Service 레이어 단에서 시행한다.
  • 단일 도메인으로 로직을 수행할 수 없을 때, 엔티티 id만 갖고 로직을 처리할 수 있게 해보자. => 이렇게 하면 엔티티나 DTO가 왔다리갔다리 할 필요가 없다. (추후 적용 예정)
  • https://www.slipp.net/questions/79

12월 11일 컨벤션 추가

  • Service: JPA가 지원하는 메서드명 + Dto 이름을 짓는다. ex) findDtoById()
  • 만약 하나의 Service에서 다른 Service 메서드를 사용해야하는 상황이라면 그 메서드는 반환 값을 Entity로 둔다.
    • 이럴 경우 메서드 명은 JPA가 지원하는 메서드명 그대로 짓는다.
    • 이 메서드는 Controller에서 사용 금지

4. 테스트 코드

  • @DisplayName을 사용하지 않고 한글로..

5. 커밋 메시지

  • 커밋 메시지 앞에 헤더를 붙인다 feat, refactor, test, fix, docs, style
  • 커밋 메시지는 한국어로 작성한다
# 커밋 메시지
[#이슈번호] 메시지

# 스쿼시 머지 메시지
메시지 (#PR번호)

6. 로깅 전략

사용법

공부해서 남주자

11월 26일 금요일에 공유

주제 이름
Spring Security 베디
Github OAuth 규동
Spring Rest Docs 이바
Util 라이브러리 어떻게 만들까 제이
Webpack3 에헴