<aside> 💡 IBAS Project의 주요한 Style Convention은 깃허브 Issue를 통해 논의되고 정해집니다. 프로젝트의 모든 멤버가 스타일 결정에 참여하고 의견을 제시할 수 있습니다. 아래는 논의 예시입니다.

• import 시 * 와일드카드 사용여부 논의
• PR Merge 방식에 대한 논의
• JUnit / AssertJ 채택 논의 </aside>

IBAS Backend code convention은 기본적으로 Google JAVA style convention을 따르고 있습니다. 하지만 Google JAVA style convention 외에 추가로 정의해야 하는 부분, 팀원들간의 논의를 통해 새로 정의한 부분은 따로 표시하였습니다.

1. File name

1.1 Class name

클래스 이름은 UpperCamelCase를 사용합니다.

예시:

• ProjectBoardRepository
• ProjectBoardServiceImpl
• ProjectBoardDetailDto

1.2 DTO name

DTO 이름은 관련된 Entity 이름 앞 또는 뒤에 CRUD 기능이나 유형을 명시한 후, Dto를 추가합니다. 단일 조회는 Entity 뒤에 Detail을 붙이고, 목록 조회는 바로 Entity 뒤에 Dto를 붙입니다. 저장 기능은 영어 어순에 맞게 Entity 앞에 Save를 사용합니다.

예시:

• 단일 조회 (Detail) (R: Read)
  • ProjectBoardDetailDto
  • BudgetApplicationDetailDto
• 목록 조회 (R: Read)
  • ProjectBoardDto
  • BudgetApplicationDto
• 저장 (CUD: Create, Update, Delete)
  • SaveProjectBoardDto
  • SaveBudgetApplicationDto