mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-31 22:23:27 +08:00
526a9070e6
Translate 6 CLAUDE.md examples (project, user, SaaS Next.js, Django API, Go microservice, Rust API) and copy statusline.json config.
101 lines
2.3 KiB
Markdown
101 lines
2.3 KiB
Markdown
# 프로젝트 CLAUDE.md 예제
|
|
|
|
프로젝트 수준의 CLAUDE.md 파일 예제입니다. 프로젝트 루트에 배치하세요.
|
|
|
|
## 프로젝트 개요
|
|
|
|
[프로젝트에 대한 간단한 설명 - 기능, 기술 스택]
|
|
|
|
## 핵심 규칙
|
|
|
|
### 1. 코드 구성
|
|
|
|
- 큰 파일 소수보다 작은 파일 다수를 선호
|
|
- 높은 응집도, 낮은 결합도
|
|
- 일반적으로 200-400줄, 파일당 최대 800줄
|
|
- 타입별이 아닌 기능/도메인별로 구성
|
|
|
|
### 2. 코드 스타일
|
|
|
|
- 코드, 주석, 문서에 이모지 사용 금지
|
|
- 항상 불변성 유지 - 객체나 배열을 직접 변경하지 않음
|
|
- 프로덕션 코드에 console.log 사용 금지
|
|
- try/catch를 사용한 적절한 에러 처리
|
|
- Zod 또는 유사 라이브러리를 사용한 입력 유효성 검사
|
|
|
|
### 3. 테스트
|
|
|
|
- TDD: 테스트를 먼저 작성
|
|
- 최소 80% 커버리지
|
|
- 유틸리티에 대한 단위 테스트
|
|
- API에 대한 통합 테스트
|
|
- 핵심 흐름에 대한 E2E 테스트
|
|
|
|
### 4. 보안
|
|
|
|
- 하드코딩된 시크릿 금지
|
|
- 민감한 데이터는 환경 변수 사용
|
|
- 모든 사용자 입력 유효성 검사
|
|
- 매개변수화된 쿼리만 사용
|
|
- CSRF 보호 활성화
|
|
|
|
## 파일 구조
|
|
|
|
```
|
|
src/
|
|
|-- app/ # Next.js app router
|
|
|-- components/ # 재사용 가능한 UI 컴포넌트
|
|
|-- hooks/ # 커스텀 React hooks
|
|
|-- lib/ # 유틸리티 라이브러리
|
|
|-- types/ # TypeScript 타입 정의
|
|
```
|
|
|
|
## 주요 패턴
|
|
|
|
### API 응답 형식
|
|
|
|
```typescript
|
|
interface ApiResponse<T> {
|
|
success: boolean
|
|
data?: T
|
|
error?: string
|
|
}
|
|
```
|
|
|
|
### 에러 처리
|
|
|
|
```typescript
|
|
try {
|
|
const result = await operation()
|
|
return { success: true, data: result }
|
|
} catch (error) {
|
|
console.error('Operation failed:', error)
|
|
return { success: false, error: 'User-friendly message' }
|
|
}
|
|
```
|
|
|
|
## 환경 변수
|
|
|
|
```bash
|
|
# 필수
|
|
DATABASE_URL=
|
|
API_KEY=
|
|
|
|
# 선택
|
|
DEBUG=false
|
|
```
|
|
|
|
## 사용 가능한 명령어
|
|
|
|
- `/tdd` - 테스트 주도 개발 워크플로우
|
|
- `/plan` - 구현 계획 생성
|
|
- `/code-review` - 코드 품질 리뷰
|
|
- `/build-fix` - 빌드 에러 수정
|
|
|
|
## Git 워크플로우
|
|
|
|
- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`
|
|
- main 브랜치에 직접 커밋 금지
|
|
- PR은 리뷰 필수
|
|
- 병합 전 모든 테스트 통과 필수
|