mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-12 12:43:32 +08:00
docs: address Korean translation review feedback
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
---
|
||||
name: build-fix
|
||||
description: 최소한의 안전한 변경으로 build 및 타입 오류를 점진적으로 수정합니다.
|
||||
---
|
||||
|
||||
# Build 오류 수정
|
||||
|
||||
최소한의 안전한 변경으로 build 및 타입 오류를 점진적으로 수정합니다.
|
||||
@@ -14,7 +19,7 @@
|
||||
| `pom.xml` | `mvn compile` |
|
||||
| `build.gradle` | `./gradlew compileJava` |
|
||||
| `go.mod` | `go build ./...` |
|
||||
| `pyproject.toml` | `python -m py_compile` 또는 `mypy .` |
|
||||
| `pyproject.toml` | `python -m compileall .` 또는 `mypy .` |
|
||||
|
||||
## 2단계: 오류 파싱 및 그룹화
|
||||
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
---
|
||||
name: checkpoint
|
||||
description: 워크플로우에서 checkpoint를 생성, 검증, 조회 또는 정리합니다.
|
||||
---
|
||||
|
||||
# Checkpoint 명령어
|
||||
|
||||
워크플로우에서 checkpoint를 생성하거나 검증합니다.
|
||||
|
||||
## 사용법
|
||||
|
||||
`/checkpoint [create|verify|list] [name]`
|
||||
`/checkpoint [create|verify|list|clear] [name]`
|
||||
|
||||
## Checkpoint 생성
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@
|
||||
- 800줄 초과 파일
|
||||
- 4단계 초과 중첩 깊이
|
||||
- 누락된 에러 처리
|
||||
- console.log 문
|
||||
- 디버그 로깅 문구(예: 개발용 로그/print 등)
|
||||
- TODO/FIXME 주석
|
||||
- 공개 API에 대한 JSDoc 누락
|
||||
- 활성 언어에 대한 공개 API 문서 누락(예: JSDoc/Go doc/Docstring 등)
|
||||
|
||||
**모범 사례 (MEDIUM):**
|
||||
- 변이(Mutation) 패턴 (불변 패턴을 사용하세요)
|
||||
|
||||
@@ -36,7 +36,7 @@ e2e-runner 에이전트가 수행하는 작업:
|
||||
|
||||
## 사용 예시
|
||||
|
||||
```
|
||||
````
|
||||
User: /e2e 마켓 검색 및 조회 흐름 테스트
|
||||
|
||||
Agent (e2e-runner):
|
||||
@@ -200,7 +200,7 @@ Running 3 tests using 3 workers
|
||||
```
|
||||
|
||||
✅ CI/CD 통합 준비가 완료된 E2E 테스트 모음!
|
||||
```
|
||||
````
|
||||
|
||||
## 테스트 아티팩트
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
## 사용법
|
||||
|
||||
`/eval [define|check|report|list] [feature-name]`
|
||||
`/eval [define|check|report|list|clean] [feature-name]`
|
||||
|
||||
## 평가 정의
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ go mod tidy -v
|
||||
|
||||
## 예시 세션
|
||||
|
||||
```text
|
||||
````text
|
||||
User: /go-build
|
||||
|
||||
Agent:
|
||||
@@ -141,7 +141,7 @@ ok project/internal/handler 0.023s
|
||||
| 남은 이슈 | 0 |
|
||||
|
||||
Build 상태: ✅ 성공
|
||||
```
|
||||
````
|
||||
|
||||
## 자주 발생하는 에러
|
||||
|
||||
|
||||
@@ -68,7 +68,7 @@ govulncheck ./...
|
||||
|
||||
## 사용 예시
|
||||
|
||||
```text
|
||||
````text
|
||||
User: /go-review
|
||||
|
||||
Agent:
|
||||
@@ -125,7 +125,7 @@ return fmt.Errorf("get user %s: %w", userID, err)
|
||||
- MEDIUM: 0
|
||||
|
||||
권장: ❌ CRITICAL 이슈가 수정될 때까지 merge 차단
|
||||
```
|
||||
````
|
||||
|
||||
## 승인 기준
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ node scripts/setup-package-manager.js --list
|
||||
3. **package.json**: `packageManager` 필드
|
||||
4. **락 파일**: package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb의 존재 여부
|
||||
5. **전역 설정**: `~/.claude/package-manager.json`
|
||||
6. **폴백**: 사용 가능한 첫 번째 패키지 매니저 (pnpm > bun > yarn > npm)
|
||||
6. **폴백**: `npm`
|
||||
|
||||
## 설정 파일
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@ REPEAT: 다음 기능/시나리오
|
||||
|
||||
## 사용 예시
|
||||
|
||||
```
|
||||
````
|
||||
User: /tdd 마켓 유동성 점수를 계산하는 함수가 필요합니다
|
||||
|
||||
Agent (tdd-guide):
|
||||
@@ -251,7 +251,7 @@ Coverage: 100% ✅ (목표: 80%)
|
||||
```
|
||||
|
||||
✅ TDD 세션 완료!
|
||||
```
|
||||
````
|
||||
|
||||
## TDD 모범 사례
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
name: test-coverage
|
||||
description: 테스트 커버리지를 분석하고, 80% 이상을 목표로 누락된 테스트를 식별하고 생성합니다.
|
||||
---
|
||||
|
||||
# 테스트 커버리지
|
||||
|
||||
테스트 커버리지를 분석하고, 갭을 식별하며, 80% 이상 커버리지 달성을 위해 누락된 테스트를 생성합니다.
|
||||
|
||||
@@ -10,15 +10,16 @@
|
||||
|
||||
## 2단계: 코드맵 생성
|
||||
|
||||
`docs/CODEMAPS/` (또는 `.reports/codemaps/`)에 코드맵 생성 또는 업데이트:
|
||||
`docs/CODEMAPS/`에 코드맵 생성 또는 업데이트:
|
||||
|
||||
| 파일 | 내용 |
|
||||
|------|------|
|
||||
| `architecture.md` | 상위 시스템 다이어그램, 서비스 경계, 데이터 흐름 |
|
||||
| `INDEX.md` | 전체 코드베이스 개요와 영역별 링크 |
|
||||
| `backend.md` | API 라우트, 미들웨어 체인, 서비스 → 리포지토리 매핑 |
|
||||
| `frontend.md` | 페이지 트리, 컴포넌트 계층, 상태 관리 흐름 |
|
||||
| `data.md` | 데이터베이스 테이블, 관계, 마이그레이션 히스토리 |
|
||||
| `dependencies.md` | 외부 서비스, 서드파티 통합, 공유 라이브러리 |
|
||||
| `database.md` | 데이터베이스 스키마, 마이그레이션, 저장소 계층 |
|
||||
| `integrations.md` | 외부 서비스, 서드파티 통합, 어댑터 |
|
||||
| `workers.md` | 백그라운드 작업, 큐, 스케줄러 |
|
||||
|
||||
### 코드맵 형식
|
||||
|
||||
@@ -41,27 +42,33 @@ src/repos/user.ts (데이터베이스 접근, 80줄)
|
||||
- Stripe (결제 처리)
|
||||
```
|
||||
|
||||
## 3단계: 변경 감지
|
||||
## 3단계: 영역 분류
|
||||
|
||||
1. 이전 코드맵이 있는 경우 변경 비율 계산
|
||||
2. 변경이 30%를 초과하면 diff를 표시하고 덮어쓰기 전에 사용자 승인 요청
|
||||
3. 변경이 30% 이하이면 기존 파일에 바로 업데이트
|
||||
생성기는 파일 경로 패턴을 기반으로 영역을 자동 분류합니다:
|
||||
|
||||
1. 프론트엔드: `app/`, `pages/`, `components/`, `hooks/`, `.tsx`, `.jsx`
|
||||
2. 백엔드: `api/`, `routes/`, `controllers/`, `services/`, `.route.ts`
|
||||
3. 데이터베이스: `db/`, `migrations/`, `prisma/`, `repositories/`
|
||||
4. 통합: `integrations/`, `adapters/`, `connectors/`, `plugins/`
|
||||
5. 워커: `workers/`, `jobs/`, `queues/`, `tasks/`, `cron/`
|
||||
|
||||
## 4단계: 메타데이터 추가
|
||||
|
||||
각 코드맵에 최신 정보 헤더를 추가합니다:
|
||||
|
||||
```markdown
|
||||
<!-- Generated: 2026-02-11 | Files scanned: 142 | Token estimate: ~800 -->
|
||||
**Last Updated:** 2026-03-12
|
||||
**Total Files:** 42
|
||||
**Total Lines:** 1875
|
||||
```
|
||||
|
||||
## 5단계: 분석 보고서 저장
|
||||
## 5단계: 인덱스와 영역 문서 동기화
|
||||
|
||||
`.reports/codemap-diff.txt`에 요약을 작성합니다:
|
||||
- 마지막 스캔 이후 추가/제거/수정된 파일
|
||||
- 새로 감지된 의존성
|
||||
- 아키텍처 변경 사항 (새 라우트, 새 서비스 등)
|
||||
- 90일 이상 업데이트되지 않은 문서에 대한 오래된 항목 경고
|
||||
`INDEX.md`는 생성된 영역 문서를 링크하고 요약해야 합니다:
|
||||
- 각 영역의 파일 수와 총 라인 수
|
||||
- 감지된 엔트리 포인트
|
||||
- 저장소 트리의 간단한 ASCII 개요
|
||||
- 영역별 세부 문서 링크
|
||||
|
||||
## 팁
|
||||
|
||||
@@ -69,4 +76,4 @@ src/repos/user.ts (데이터베이스 접근, 80줄)
|
||||
- 전체 코드 블록 대신 **파일 경로와 함수 시그니처** 사용
|
||||
- 효율적인 컨텍스트 로딩을 위해 각 코드맵을 **1000 토큰 미만**으로 유지
|
||||
- 장황한 설명 대신 데이터 흐름에 ASCII 다이어그램 사용
|
||||
- 주요 기능 추가 또는 리팩토링 세션 후 실행
|
||||
- 주요 기능 추가 또는 리팩토링 세션 후 `npx tsx scripts/codemaps/generate.ts` 실행
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
name: update-docs
|
||||
description: 코드베이스를 기준으로 문서를 동기화하고 생성된 섹션을 갱신합니다.
|
||||
---
|
||||
|
||||
# 문서 업데이트
|
||||
|
||||
문서를 코드베이스와 동기화하고, 원본 소스 파일에서 생성합니다.
|
||||
|
||||
@@ -23,11 +23,15 @@
|
||||
- 통과/실패 수 보고
|
||||
- 커버리지 비율 보고
|
||||
|
||||
5. **Console.log 감사**
|
||||
5. **시크릿 스캔**
|
||||
- 소스 파일에서 API 키, 토큰, 비밀값 패턴 검색
|
||||
- 발견 위치 보고
|
||||
|
||||
6. **Console.log 감사**
|
||||
- 소스 파일에서 console.log 검색
|
||||
- 위치 보고
|
||||
|
||||
6. **Git 상태**
|
||||
7. **Git 상태**
|
||||
- 커밋되지 않은 변경사항 표시
|
||||
- 마지막 커밋 이후 수정된 파일 표시
|
||||
|
||||
|
||||
Reference in New Issue
Block a user