내 손 안의 흐려지는 단어장, 'term b/ur' 는 자신이 단어를 얼마나 잘 암기했는지 객관적으로 파악할 수 없는 불편한 문제점을 흐려짐을 통해 쉽고 직관적으로 암기 정도를 파악할 수 있도록 도움을 주는 모바일 서비스입니다.

김창균/ckkim817	정정교/Junggyo1020

Git Flow

• main : 배포 프랜치
• develop : 개발 브랜치
• type/#이슈번호 : 세부 개발 브랜치
  • 생성한 이슈번호로 브랜치를 생성한다.
  • ex) feat/#20
• PR 머지 후 해당 브랜치는 삭제한다.

[type/#이슈번호]: 작업내용

ex) [feat/#20]: 검색 결과 필터링 기능 추가

type/#이슈번호

ex) feat/#20

네이밍 규칙

• lowerCamelCase 사용
  • 클래스, 인터페이스, db스키마의 경우 UpperCamelCase
• 함수명 : 동사+명사
  • API와 직결되는 함수는 CRUD 명칭을 앞에 달기
    • ex. Create → create000 Read → get000 (getUserById, getUsers) Update → update000 Delete → delete000
• 변수명 : 명사+명사 or 형용사+명사
• 명사는 단수로 쓰지 않되 개수를 나타내는 단어 꼭 적어주기
  • ex. 복수 : getUsers() / 단수 : getUser()

그 외 코드 작성 시 유의 사항

• Exception

  • 서비스 로직에 관련된 예외는 서비스 단에서 던지기
  • validation 관련 예외는 컨트롤러 단에서 던지기

• Type Assertion

  • type 지정 필수
    • 변수, 함수 모두
  • 서비스 단에서 스키마와 관련된 변수 및 함수 타입 단언은 경우의 따라 단언을 하지 않을 수 있다.

• 주석 작성 시 띄어쓰기 넣기

  // 이렇게
  
  /**
   * 여기에 이렇게 합시다
   */

들여쓰기 및 띄어쓰기

• 들여쓰기에는 탭(tab) 대신 4개의 space를 사용합니다.
• 클래스 내 변수는 한 줄 공백을 두고 작성합니다.

줄바꿈

• 함수 정의가 **매개변수의 개수가 3개를 초과하는 경우**에는 아래와 같이 줄바꿈합니다.

  public static UserResponseDto of(Long id, String nickName, Rank userRank, int point, 
  		                 int coupon, long interest, int waiting, int finish,
  		                 int ready, int delivering, int delivered,
  ){
      ...
  }

Code Review

• 커뮤니케이션 비용을 줄이기 위한 Pn 룰

  • P1: 꼭 반영해주세요 (Request changes)

  • P2: 적극적으로 고려해주세요 (Request changes)

  • P3: 웬만하면 반영해 주세요 (Comment)

  • P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)

  • P5: 그냥 사소한 의견입니다 (Approve)

https://rowan-octopus-031.notion.site/NOW-Sopkathon-IOS-4-c9f05ece2cd44427b696ebcd25037ec0?pvs=4

├── build.gradle
└── 📂 src/main/java/org/sopkathon
        ├── 📂 config // Config 관련 파일 구현
        ├── 📂 controller // 컨트롤러
        ├── 📂 domain // 도메인
        │       ├── 📂 common // 공통 도메인 관련 파일 ex) BaseEntity
        │       ├── 📂 enums // 도메인 관련 enum 파일
        │       └── 📂 mapping // 도메인 관련 매핑 테이블
        │  
        ├── 📂 dto
        │       ├── 📂 request // requestDto 구현
        │       └── 📂 response // responseDto 구현
        │
        ├── 📂 exception
        │       ├── 📂 dto // ex) ErrorResponse, SuccessResponse
        │       ├── 📂 enums // ex) ErrorMessage, SuccessMessage
        │       ├── CustomException.java
        │       └── GlobalExceptionHandler.java
        │ 
        ├── 📂 repository // 레포지토리
        │  
        ├── 📂 service // 서비스 로직
        │
        └── SopkathonApplication.java