Repository navigation
Coding Convention
wcorn edited this page Apr 2, 2026
·
1 revision
BE/FE 공통 코딩 규칙을 정의한다.
<타입> : <제목>
<본문>
<꼬릿말>
| 규칙 | 내용 |
|---|---|
| 제목 | 50자 이내, 끝에 마침표 금지, 명령어로 작성 |
| 본문 | 구체적인 내용, -로 구분, 한 줄 72자 이내 |
| 꼬릿말 | 관련 이슈 번호 (예: #7) |
| 타입 | 용도 |
|---|---|
feat |
새로운 기능 추가 |
fix |
버그 수정 |
docs |
문서 수정 |
test |
테스트 코드 추가 |
refactor |
코드 리팩토링 |
style |
포맷팅 등 코드 변경이 없는 수정 |
chore |
빌드, 패키지 매니저 수정 |
- main에 직접 push 금지
- feature 브랜치에서 PR을 통해 머지
- PR의 base 브랜치는 항상 main
| 대상 | 규칙 | 예시 |
|---|---|---|
| 클래스 | PascalCase |
AuthService, MemberRepository
|
| 메서드/변수 | camelCase |
findByLoginId, accessToken
|
| 상수 | UPPER_SNAKE_CASE | AUTHORIZATION_HEADER |
| 패키지 | 소문자 | ds.project.orino.domain.member |
| 에러 코드 | UPPER_SNAKE_CASE (enum) | INVALID_CREDENTIALS |
멀티모듈 아키텍처를 따른다. (상세: BE 코드 아키텍처)
도메인 모듈 (Entity/Repository):
ds.project.orino.domain.{도메인}/
├── entity/{Entity}.java
└── repository/{Entity}Repository.java
앱 모듈 (Controller/Service/DTO):
ds.project.orino.{도메인}/
├── controller/{Domain}Controller.java
├── service/{Domain}Service.java
└── dto/
├── {Name}Request.java
└── {Name}Response.java
| 패턴 | 접미사 | 위치 |
|---|---|---|
| REST 컨트롤러 | Controller |
app-api |
| 애플리케이션 서비스 | Service |
app-api |
| JPA 엔티티 | - (도메인 명사) | domain-rdb |
| JPA 리포지토리 | Repository |
domain-rdb |
| 요청 DTO | Request |
app-api |
| 응답 DTO | Response |
app-api |
- Java
record를 사용한다 - 요청 DTO에 validation 어노테이션(
@NotBlank,@Size등) 부착 - 응답 DTO는 필요한 필드만 노출
- 생성자 주입을 사용한다 (필드 주입 금지)
-
@Autowired생략 (단일 생성자는 자동 주입)
| 대상 | 규칙 | 예시 |
|---|---|---|
| 컴포넌트 | PascalCase |
LoginForm.tsx, GoalCard.tsx
|
| 훅 | camelCase, use 접두사 |
useGoals.ts, useAuth.ts
|
| 유틸/함수 | camelCase | formatDate.ts |
| 타입/인터페이스 | PascalCase |
Goal, LoginRequest
|
| 상수 | UPPER_SNAKE_CASE | API_BASE_URL |
| 디렉토리 | kebab-case 또는 camelCase |
api/, components/
|
Feature-based 구조를 따른다. (상세: FE 코드 아키텍처)
features/{domain}/
├── api/ # TanStack Query 훅
├── components/ # 도메인 컴포넌트
├── hooks/ # 도메인 훅
├── store/ # Zustand 스토어
└── types/ # 도메인 타입
- 함수형 컴포넌트만 사용 (클래스 컴포넌트 금지)
- Props는 인라인 타입 또는 별도
interface로 정의 - 컴포넌트 파일 하나에 컴포넌트 하나
-
features/간 직접 import 금지 - 공유가 필요하면
shared/로 올린다 - 절대 경로 import 권장 (Vite alias 설정 시)
- strict 모드 활성화
-
any사용 금지 —unknown으로 대체 후 타입 가드 - 미사용 변수/파라미터 금지 (
noUnusedLocals,noUnusedParameters)
| 구분 | 도구 | 원칙 |
|---|---|---|
| 서버 데이터 | TanStack Query | API 데이터는 반드시 Query로 관리 |
| UI 상태 | Zustand | 서버 데이터를 복제하지 않는다 |
- 사용하지 않는 코드는 주석 처리가 아닌 삭제
- 매직 넘버/문자열은 상수로 추출
- 중복 코드 3회 이상 반복 시 추출 검토
- 코드가 "왜" 이런 결정을 했는지만 주석으로 남긴다
- "무엇"을 하는지는 코드 자체가 설명하도록 작성한다
- TODO 주석은 이슈 번호와 함께 남긴다 (
// TODO #123: ...)