📕Convention

[ghrltjdtprbs]

Code Convention

---

• [[IntelliJ Java Google Style] 을 준수합니다.

  • https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml 다운로드

  • Preferences > Editor > Code Style > Java > Scheme Import > Google Style IDE 를 통해 다운로드한 설정파일 Import

  • Tab and Indents에서 Indent 및 Tab Size를 4로 변경합니다.

  • 변경이 완료되었으면 단축키를 이용해 코드를 맞출 수 있습니다.

      → 윈도우 : Ctrl + Alt + L
    
      → 맥       : md + Option+ L
    

General Convention👍👍

java : 17

springboot : 3.1.6

com.yanolja_fianl
├── domain
│   ├── user
│   │   ├── controller
│   │   ├── dto
│   │   ├── entity
│   │   ├── exception
│   │   ├── repository
│   │   └── service
│   ├── travel
│   │   ├── controller
│   │   ├── dto
│   │   ├── entity
│   │   ├── exception
│   │   ├── repository
│   │   └── service
│   ...
└── global
    ├── auth
    ├── common
    ├── config
    ├── error
    ├── infra
    └── util

Variable Convention

• 기본적인 도메인 변수는 ERD에서 작성한 변수명을 따른다.

Method Convention

• boolean 타입 반환 메서드 : boolean isXXX( )

boolean isOutOfStock() // 재고가 다 소진되었는지
boolean isNull()       // Null 값 인지?

Test Convention

  @DisplayName("회원가입을 할 수 있다.")
  @Test
  void _willSuccess() throws Exception {
      // given
      SignUpRequest requestDto = new SignUpRequest("user11", "password",
              "password", "테스트유저1");
      // when then
      mockMvc.perform(
                  post("/api/v1/signUp")
                  .contentType(MediaType.APPLICATION_JSON)
                  .content(objectMapper.writeValueAsString(requestDto)))
              .andDo(print())
              .andExpect(status().isCreated());
   }
      
   @DisplayName("null이면 실패한다.")
   @Test
   void null_willFail() throws Exception {
      // given
      SignUpRequest requestDto = new SignUpRequest(null, "password",
               "password", "테스트유저1")
       // when then
       mockMvc.perform(
                   post("/api/v1/signUp")
                   .contentType(MediaType.APPLICATION_JSON)
                   .content(objectMapper.writeValueAsString(requestDto)))
               .andDo(print())
               .andExpect(status().isBadRequest())
               .andExpect(jsonPath("$.message").value("아이디를 입력해주세요."));
    }
        

공통 사항

• 다른사람들이 어떤 테스트가 실패했는지 한눈에 알아 볼 수 있게 @DisplayName(””) 설정하기.

Git

---

Commit Convention

앞에 태그 붙여주세요!

• [feat] : 새로운 기능을 추가하는 경우
• [fix] : 버그를 고친경우
• [docs] : 문서를 수정한 경우
• [style] : 코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는경우
• [refactor] : 코드 리펙토링
• [test] : 테스트 코드. 리펙토링 테스트 코드를 추가했을 때
• [Rename] : 파일명(or 폴더명) 을 수정한 경우
• [Remove] : 코드(파일) 의 삭제가 있을 때. "Clean", "Eliminate" 를 사용하기도 함

PR Convention

PR 이름에 커밋과 동일하게 앞에 태그 붙여주세요!

⭐⭐pr 단위 : 기능별로 pr 올리되 파일기준 10개 내외⭐⭐

Branch Protection Rule

팀원 모두의 리뷰를 받아야 merge할 수 있도록 브랜치 규칙 설정

Pull requests → 리뷰할 pr선택 → 상단의 Add your review → Review changes → 리뷰 작성 → Approve 선택 → Submit review

• 옆에 체크 표시가 떠야 리뷰 완료
• 취소는 체크 표시 옆 🔄️ 선택