<aside> 📌

아래는 예시이므로 참고하여 팀 내 규칙을 정해주세요!!!

</aside>

📨 환경 설정

• Java 17
• Spring Boot 3.5.4
• 의존성 (dependency):
  • JPA Hibernate 맞추기
  • web plugs 맞추기
  • gradle 툴 맞추기
  • lombok 버전 맞추기
  • spring security
  • jwt
  • kafka

✨API 설계 컨벤션

[공통]

• 최대한 Rest 맞춰서 작성하기

1. delete API 작성 시 유의 사항
   • 200 ok에 true false 값만 반환

🔌 코드 컨벤션

1. 코드 리팩토링 하기 전에는 리팩토링 담당자가 팀 전체에 공유하기

<aside> 🏷️

명명 규칙

</aside>

1. 다른 사람이 맡은 코드는 임의로 고치지 말고 꼭 담당자랑 얘기하기

2. PR 올리기 전 두 가지 꼭 하기

   • 코드 정렬: Ctrl+Alt+L
   • 불필요한 import 제거: Ctrl+Alt+O(알파벳 O)

3. Collection 변수는 변수명 + Collection 타입

   • List<Keyword> keywordList (O)
   • List<Keyword> keywords (X)

4. 주석은 // 만 사용하기

5. DTO 명명 시 유의 사항 (어떻게 하기로 한건지 다시 물어보기)

   • CreateUserRequestDto
   • ReadUserResponseDto
   • UpdateUserResponseDto

6. API 명명 시 유의 사항

• 자바 컨벤션 따르기(카멜케이스)
• 줄임말 사용 금지

1. ERD 명명 시 유의 사항
   • 카멜케이스 대신 언더바 사용하기
   • 줄임말 금지
   • 스프링에서 자바컨벤션 따르면 자동으로 스네이크 케이스로 바꿔줌