목차

명명 규칙

주석 작성

브랜치 전략

패키지 구조

API 설계

PR 요청 및 코드 리뷰

에러 처리

테스트

명명 규칙

**카멜 케이스(camelCase)**: 첫 단어는 소문자, 이후 단어의 첫 글자는 대문자로 표기
	- 예: userName, totalAmount

파스칼 **케이스(camelCase)**: 각 단어의 첫 글자를 대문자로 표기
	- 예: UserService, UserController

스네이크 케이스(Snake Case): 단어 사이를 언더스코어(_)로 구분하고 모든 문자를 소문자로 표기
	- 예: user_name, phone_number

• 상수 : 대문자 스네이크 케이스
  • 예: API_KEY , DEFAULT_TIMEOUT
• 변수/함수 : 카멜 케이스
  • 예: userName, getUserName()
• 패키지 이름: 모든 문자를 소문자로 작성하고, 도메인 이름을 반영
  • 예: com.example.project
• 클래스 이름: 파스칼 케이스를 사용하며, 명사형으로 작성
  • 예: UserService, ProductController

주석 작성

• 클래스, 인터페이스, 메소드에 대해 /** */ 형식의 Javadoc 주석을 사용

/**
 * 사용자 서비스를 처리하는 클래스입니다.
 */
@Service
public class UserService {
    /**
     * 사용자 정보를 조회합니다.
     * @param userId 조회할 사용자 ID
     * @return 조회된 사용자 정보
     */
    public User getUser(Long userId) {
				...
    }
}