hjdave/everything-claude-code-zh
1
0
Fork 0
mirror of https://github.com/sweetwisdom/everything-claude-code-zh.git synced 2026-03-22 06:20:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: 完成所有文档的中文翻译并应用到项目

Browse Source
This commit is contained in:
xuxiang
2026-01-28 00:12:54 +08:00
parent 0ced59a26b
commit e133f58e1c
76 changed files with 6808 additions and 6170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
skills/project-guidelines-example/SKILL.md
View File

@@ -1,33 +1,33 @@
# Project Guidelines Skill (Example)
# 项目指南技能（Project Guidelines Skill，示例）
This is an example of a project-specific skill. Use this as a template for your own projects.
这是一个特定项目的技能（Skill）示例。请将其用作你自定义项目的模板。
Based on a real production application: [Zenith](https://zenith.chat) - AI-powered customer discovery platform.
基于真实的生产应用：[Zenith](https://zenith.chat) - AI 驱动的客户发现平台。
---
## When to Use
## 何时使用 (When to Use)
Reference this skill when working on the specific project it's designed for. Project skills contain:
- Architecture overview
- File structure
- Code patterns
- Testing requirements
- Deployment workflow
在处理该特定项目时参考此技能。项目技能包含：
- 架构概览 (Architecture overview)
- 文件结构 (File structure)
- 代码模式 (Code patterns)
- 测试要求 (Testing requirements)
- 部署工作流 (Deployment workflow)
---
## Architecture Overview
## 架构概览 (Architecture Overview)
**Tech Stack:**
- **Frontend**: Next.js 15 (App Router), TypeScript, React
- **Backend**: FastAPI (Python), Pydantic models
- **Database**: Supabase (PostgreSQL)
- **AI**: Claude API with tool calling and structured output
- **Deployment**: Google Cloud Run
- **Testing**: Playwright (E2E), pytest (backend), React Testing Library
**技术栈 (Tech Stack)：**
- **前端 (Frontend)**：Next.js 15 (App Router), TypeScript, React
- **后端 (Backend)**：FastAPI (Python), Pydantic 模型
- **数据库 (Database)**：Supabase (PostgreSQL)
- **AI**：Claude API（支持工具调用与结构化输出）
- **部署 (Deployment)**：Google Cloud Run
- **测试 (Testing)**：Playwright (E2E), pytest (后端), React Testing Library
**Services:**
**服务 (Services)：**
```
┌─────────────────────────────────────────────────────────────┐
│ Frontend │
@@ -52,44 +52,44 @@ Reference this skill when working on the specific project it's designed for. Pro
---
## File Structure
## 文件结构 (File Structure)
```
project/
├── frontend/
│ └── src/
│ ├── app/ # Next.js app router pages
│ │ ├── api/ # API routes
│ │ ├── (auth)/ # Auth-protected routes
│ │ └── workspace/ # Main app workspace
│ ├── components/ # React components
│ │ ├── ui/ # Base UI components
│ │ ├── forms/ # Form components
│ │ └── layouts/ # Layout components
│ ├── hooks/ # Custom React hooks
│ ├── lib/ # Utilities
│ ├── types/ # TypeScript definitions
│ └── config/ # Configuration
│ ├── app/ # Next.js App Router 页面
│ │ ├── api/ # API 路由
│ │ ├── (auth)/ # 身份验证保护的路由
│ │ └── workspace/ # 主应用工作区
│ ├── components/ # React 组件
│ │ ├── ui/ # 基础 UI 组件
│ │ ├── forms/ # 表单组件
│ │ └── layouts/ # 布局组件
│ ├── hooks/ # 自定义 React 钩子 (Hooks)
│ ├── lib/ # 工具库
│ ├── types/ # TypeScript 类型定义
│ └── config/ # 配置
│
├── backend/
│ ├── routers/ # FastAPI route handlers
│ ├── models.py # Pydantic models
│ ├── main.py # FastAPI app entry
│ ├── auth_system.py # Authentication
│ ├── database.py # Database operations
│ ├── services/ # Business logic
│ └── tests/ # pytest tests
│ ├── routers/ # FastAPI 路由处理器
│ ├── models.py # Pydantic 模型
│ ├── main.py # FastAPI 应用入口
│ ├── auth_system.py # 身份验证系统
│ ├── database.py # 数据库操作
│ ├── services/ # 业务逻辑
│ └── tests/ # pytest 测试
│
├── deploy/ # Deployment configs
├── docs/ # Documentation
└── scripts/ # Utility scripts
├── deploy/ # 部署配置
├── docs/ # 文档
└── scripts/ # 工具脚本
```
---
## Code Patterns
## 代码模式 (Code Patterns)
### API Response Format (FastAPI)
### API 响应格式 (FastAPI)
```python
from pydantic import BaseModel
@@ -111,7 +111,7 @@ class ApiResponse(BaseModel, Generic[T]):
return cls(success=False, error=error)
```
### Frontend API Calls (TypeScript)
### 前端 API 调用 (TypeScript)
```typescript
interface ApiResponse<T> {
@@ -144,7 +144,7 @@ async function fetchApi<T>(
}
```
### Claude AI Integration (Structured Output)
### Claude AI 集成 (结构化输出)
```python
from anthropic import Anthropic
@@ -170,7 +170,7 @@ async def analyze_with_claude(content: str) -> AnalysisResult:
tool_choice={"type": "tool", "name": "provide_analysis"}
)
# Extract tool use result
# 提取工具调用结果
tool_use = next(
block for block in response.content
if block.type == "tool_use"
@@ -179,7 +179,7 @@ async def analyze_with_claude(content: str) -> AnalysisResult:
return AnalysisResult(**tool_use.input)
```
### Custom Hooks (React)
### 自定义钩子 (React Hooks)
```typescript
import { useState, useCallback } from 'react'
@@ -217,22 +217,22 @@ export function useApi<T>(
---
## Testing Requirements
## 测试要求 (Testing Requirements)
### Backend (pytest)
### 后端 (pytest)
```bash
# Run all tests
# 运行所有测试
poetry run pytest tests/
# Run with coverage
# 运行并生成覆盖率报告
poetry run pytest tests/ --cov=. --cov-report=html
# Run specific test file
# 运行特定测试文件
poetry run pytest tests/test_auth.py -v
```
**Test structure:**
**测试结构：**
```python
import pytest
from httpx import AsyncClient
@@ -250,20 +250,20 @@ async def test_health_check(client: AsyncClient):
assert response.json()["status"] == "healthy"
```
### Frontend (React Testing Library)
### 前端 (React Testing Library)
```bash
# Run tests
# 运行测试
npm run test
# Run with coverage
# 运行并生成覆盖率报告
npm run test -- --coverage
# Run E2E tests
# 运行 E2E 测试
npm run test:e2e
```
**Test structure:**
**测试结构：**
```typescript
import { render, screen, fireEvent } from '@testing-library/react'
import { WorkspacePanel } from './WorkspacePanel'
@@ -284,38 +284,38 @@ describe('WorkspacePanel', () => {
---
## Deployment Workflow
## 部署工作流 (Deployment Workflow)
### Pre-Deployment Checklist
### 部署前自查清单 (Pre-Deployment Checklist)
- [ ] All tests passing locally
- [ ] `npm run build` succeeds (frontend)
- [ ] `poetry run pytest` passes (backend)
- [ ] No hardcoded secrets
- [ ] Environment variables documented
- [ ] Database migrations ready
- [ ] 所有测试在本地通过
- [ ] `npm run build` 成功 (前端)
- [ ] `poetry run pytest` 通过 (后端)
- [ ] 无硬编码的秘钥 (Secrets)
- [ ] 环境变量已记录文档
- [ ] 数据库迁移就绪
### Deployment Commands
### 部署命令 (Deployment Commands)
```bash
# Build and deploy frontend
# 构建并部署前端
cd frontend && npm run build
gcloud run deploy frontend --source .
# Build and deploy backend
# 构建并部署后端
cd backend
gcloud run deploy backend --source .
```
### Environment Variables
### 环境变量 (Environment Variables)
```bash
# Frontend (.env.local)
# 前端 (.env.local)
NEXT_PUBLIC_API_URL=https://api.example.com
NEXT_PUBLIC_SUPABASE_URL=https://xxx.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ...
# Backend (.env)
# 后端 (.env)
DATABASE_URL=postgresql://...
ANTHROPIC_API_KEY=sk-ant-...
SUPABASE_URL=https://xxx.supabase.co
@@ -324,22 +324,22 @@ SUPABASE_KEY=eyJ...
---
## Critical Rules
## 核心规则 (Critical Rules)
1. **No emojis** in code, comments, or documentation
2. **Immutability** - never mutate objects or arrays
3. **TDD** - write tests before implementation
4. **80% coverage** minimum
5. **Many small files** - 200-400 lines typical, 800 max
6. **No console.log** in production code
7. **Proper error handling** with try/catch
8. **Input validation** with Pydantic/Zod
1. 代码、注释或文档中**严禁使用 Emoji**
2. **不可变性 (Immutability)** - 永远不要直接改变对象或数组
3. **测试驱动开发 (TDD)** - 在实现之前编写测试
4. 最小 **80% 测试覆盖率**
5. **大量小文件** - 通常为 200-400 行，最多 800 行
6. 生产代码中**严禁使用 console.log**
7. 使用 try/catch 进行**妥善的错误处理**
8. 使用 Pydantic/Zod 进行**输入验证**
---
## Related Skills
## 相关技能 (Related Skills)
- `coding-standards.md` - General coding best practices
- `backend-patterns.md` - API and database patterns
- `frontend-patterns.md` - React and Next.js patterns
- `tdd-workflow/` - Test-driven development methodology
- `coding-standards.md` - 通用代码最佳实践
- `backend-patterns.md` - API 与数据库模式
- `frontend-patterns.md` - React 与 Next.js 模式
- `tdd-workflow/` - 测试驱动开发 (TDD) 方法论