mzaxdandClaude
e3e72006b0
新增功能： - 新增 ProjectDiscoveryTask 数据模型，支持异步项目探索任务管理 - 新增 /api/discovery/tasks CRUD API，支持任务创建、查询和状态更新 - 新增 /api/discovery/tasks/:id/complete API，完成探索并自动创建项目 - 新增 discovery-service 服务层，封装多级去重和标签处理逻辑 - 新增 discover-projects 命令，支持批量探索项目 - 新增 PROJECT_CONTENT_STANDARD.md 内容标准模板 代码质量修复： - 修复状态转换验证未使用问题，防止非法状态转换 - 修复 explorationData 类型安全问题，使用 z.record(z.unknown()) 替代 z.any() - 添加事务保护到 complete API，确保项目创建和任务状态更新的原子性 代码重构： - 将 webhook/projects 的去重逻辑迁移到 discovery-service - 统一探索任务相关的验证模式到 validations.ts Co-Authored-By: Claude <noreply@anthropic.com>
2.6 KiB
2.6 KiB
项目内容标准模板
此文档定义了项目探索时需要收集的内容结构和质量标准。
必需内容
1. 基本信息
- 中文名称：项目的中文名称（如果原项目是英文，需要翻译）
- 英文名称：原始项目名称（保持原文）
- 中文描述：1-2句话概括项目功能（10-500字）
- 英文描述：项目功能的英文描述
2. 详细内容（Markdown格式）
- 项目简介：背景、目的、解决的问题
- 核心功能：主要功能列表或说明
- 技术栈：使用的技术、框架、工具
- 使用场景：适用场景和用例
- 特点亮点：与同类项目的差异化特点
3. 标签（1-10个）
- 技术标签：如
NLP,Computer Vision,React - 应用标签：如
聊天机器人,数据分析 - 状态标签：如
活跃维护,实验性项目
4. 外部链接（至少1个）
- GitHub链接：如果项目在GitHub上
- 官网链接：项目官方网站或文档
- Demo链接：在线演示地址
- 论文链接：如果有相关论文
内容质量标准
描述质量
- ✅ 清晰说明项目是做什么的
- ✅ 突出项目的核心价值
- ✅ 避免营销术语，保持客观
- ❌ 避免直接复制README第一句
内容完整性
- ✅ 从README中提取关键信息
- ✅ 重新组织内容，使其更易读
- ✅ 添加必要的上下文说明
- ❌ 不要机械翻译，要符合中文表达习惯
链接有效性
- ✅ 所有链接都必须可访问
- ✅ 优先使用GitHub仓库链接
- ✅ 包含文档或Demo链接
动态数据处理
以下数据不应写入内容中（使用GitHub Badge显示）：
- Star/Fork数量
- 最近更新时间
- 贡献者数量
- Issue/PR数量
内容来源优先级
- README.md - 主要信息来源
- 官网/文档 - 补充说明
- 代码结构 - 理解技术实现
- Issues/Discussions - 了解用户反馈
示例格式
简洁版（适用于小型项目）
## 简介
[1-2句话说明项目]
## 功能
- 功能1
- 功能2
## 技术栈
- 技术1
- 技术2
详细版（适用于复杂项目）
## 背景
[项目背景和动机]
## 核心功能
### 功能1
[详细说明]
### 功能2
[详细说明]
## 技术架构
[技术选型和架构说明]
## 使用场景
- 场景1
- 场景2
## 项目特点
- 特点1
- 特点2
注意事项
- 保持客观：避免过度夸大或营销语言
- 用户视角：从用户角度描述价值，而非技术实现细节
- 持续更新：此标准会根据需要调整
- 灵活应用：根据项目实际情况动态调整内容结构