-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
docs(zh-CN): sync Chinese docs with latest upstream changes #341
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| # Everything Claude Code (ECC) — 智能体指令 | ||
|
|
||
| 这是一个**生产就绪的 AI 编码插件**,提供 13 个专业智能体、50+ 项技能、33 条命令以及用于软件开发的自动化钩子工作流。 | ||
|
|
||
| ## 核心原则 | ||
|
|
||
| 1. **智能体优先** — 将领域任务委托给专业智能体 | ||
| 2. **测试驱动** — 先写测试再实现,要求 80%+ 覆盖率 | ||
| 3. **安全第一** — 绝不妥协安全;验证所有输入 | ||
| 4. **不可变性** — 总是创建新对象,永不修改现有对象 | ||
| 5. **先规划后执行** — 在编写代码前规划复杂功能 | ||
|
|
||
| ## 可用智能体 | ||
|
|
||
| | 智能体 | 目的 | 何时使用 | | ||
| |-------|---------|-------------| | ||
| | planner | 实施规划 | 复杂功能、重构 | | ||
| | architect | 系统设计与可扩展性 | 架构决策 | | ||
| | tdd-guide | 测试驱动开发 | 新功能、错误修复 | | ||
| | code-reviewer | 代码质量与可维护性 | 编写/修改代码后 | | ||
| | security-reviewer | 漏洞检测 | 提交前、敏感代码 | | ||
| | build-error-resolver | 修复构建/类型错误 | 构建失败时 | | ||
| | e2e-runner | 端到端 Playwright 测试 | 关键用户流程 | | ||
| | refactor-cleaner | 清理无用代码 | 代码维护 | | ||
| | doc-updater | 文档和代码地图更新 | 更新文档 | | ||
| | go-reviewer | Go 代码审查 | Go 项目 | | ||
| | go-build-resolver | Go 构建错误 | Go 构建失败 | | ||
| | database-reviewer | PostgreSQL/Supabase 专家 | 模式设计、查询优化 | | ||
| | python-reviewer | Python 代码审查 | Python 项目 | | ||
|
|
||
| ## 智能体编排 | ||
|
|
||
| 主动使用智能体,无需用户提示: | ||
|
|
||
| * 复杂功能请求 → **planner** | ||
| * 刚编写/修改的代码 → **code-reviewer** | ||
| * 错误修复或新功能 → **tdd-guide** | ||
| * 架构决策 → **architect** | ||
| * 安全敏感代码 → **security-reviewer** | ||
|
|
||
| 对于独立操作使用并行执行 — 同时启动多个智能体。 | ||
|
|
||
| ## 安全指南 | ||
|
|
||
| **在任何提交之前:** | ||
|
|
||
| * 没有硬编码的密钥(API 密钥、密码、令牌) | ||
| * 所有用户输入都经过验证 | ||
| * 防止 SQL 注入(参数化查询) | ||
| * 防止 XSS(已清理的 HTML) | ||
| * 启用 CSRF 保护 | ||
| * 已验证身份验证/授权 | ||
| * 所有端点都有限速 | ||
| * 错误消息不泄露敏感数据 | ||
|
|
||
| **密钥管理:** 绝不硬编码密钥。使用环境变量或密钥管理器。在启动时验证所需的密钥。立即轮换任何暴露的密钥。 | ||
|
|
||
| **如果发现安全问题:** 停止 → 使用 security-reviewer 智能体 → 修复 CRITICAL 问题 → 轮换暴露的密钥 → 审查代码库中的类似问题。 | ||
|
|
||
| ## 编码风格 | ||
|
|
||
| **不可变性(关键):** 总是创建新对象,永不修改。返回带有更改的新副本。 | ||
|
|
||
| **文件组织:** 许多小文件优于少数大文件。通常 200-400 行,最多 800 行。按功能/领域组织,而不是按类型组织。高内聚,低耦合。 | ||
|
|
||
| **错误处理:** 在每个层级处理错误。在 UI 代码中提供用户友好的消息。在服务器端记录详细的上下文。绝不静默地忽略错误。 | ||
|
|
||
| **输入验证:** 在系统边界验证所有用户输入。使用基于模式的验证。快速失败并给出清晰的消息。绝不信任外部数据。 | ||
|
|
||
| **代码质量检查清单:** | ||
|
|
||
| * 函数小巧(<50 行),文件专注(<800 行) | ||
| * 没有深层嵌套(>4 层) | ||
| * 适当的错误处理,没有硬编码的值 | ||
| * 可读性强、命名良好的标识符 | ||
|
|
||
| ## 测试要求 | ||
|
|
||
| **最低覆盖率:80%** | ||
|
|
||
| 测试类型(全部必需): | ||
|
|
||
| 1. **单元测试** — 单个函数、工具、组件 | ||
| 2. **集成测试** — API 端点、数据库操作 | ||
| 3. **端到端测试** — 关键用户流程 | ||
|
|
||
| **TDD 工作流(强制):** | ||
|
|
||
| 1. 先写测试(RED) — 测试应该失败 | ||
| 2. 编写最小实现(GREEN) — 测试应该通过 | ||
| 3. 重构(IMPROVE) — 验证覆盖率 80%+ | ||
|
|
||
| 故障排除:检查测试隔离 → 验证模拟 → 修复实现(而不是测试,除非测试是错误的)。 | ||
|
|
||
| ## 开发工作流 | ||
|
|
||
| 1. **规划** — 使用 planner 智能体,识别依赖项和风险,分解为阶段 | ||
| 2. **TDD** — 使用 tdd-guide 智能体,先写测试,实现,重构 | ||
| 3. **审查** — 立即使用 code-reviewer 智能体,解决 CRITICAL/HIGH 问题 | ||
| 4. **提交** — 约定式提交格式,全面的 PR 摘要 | ||
|
|
||
| ## Git 工作流 | ||
|
|
||
| **提交格式:** `<type>: <description>` — 类型:feat, fix, refactor, docs, test, chore, perf, ci | ||
|
|
||
| **PR 工作流:** 分析完整的提交历史 → 起草全面的摘要 → 包含测试计划 → 使用 `-u` 标志推送。 | ||
|
|
||
| ## 架构模式 | ||
|
|
||
| **API 响应格式:** 具有成功指示器、数据负载、错误消息和分页元数据的一致信封。 | ||
|
|
||
| **仓储模式:** 将数据访问封装在标准接口(findAll, findById, create, update, delete)后面。业务逻辑依赖于抽象接口,而不是存储机制。 | ||
|
|
||
| **骨架项目:** 搜索经过实战检验的模板,使用并行智能体(安全性、可扩展性、相关性)进行评估,克隆最佳匹配,在已验证的结构内迭代。 | ||
|
|
||
| ## 性能 | ||
|
|
||
| **上下文管理:** 对于大型重构和多文件功能,避免使用上下文窗口的最后 20%。敏感性较低的任务(单次编辑、文档、简单修复)可以容忍较高的利用率。 | ||
|
|
||
| **构建故障排除:** 使用 build-error-resolver 智能体 → 分析错误 → 增量修复 → 每次修复后验证。 | ||
|
|
||
| ## 项目结构 | ||
|
|
||
| ``` | ||
| agents/ — 13 specialized subagents | ||
| skills/ — 50+ workflow skills and domain knowledge | ||
| commands/ — 33 slash commands | ||
| hooks/ — Trigger-based automations | ||
| rules/ — Always-follow guidelines (common + per-language) | ||
| scripts/ — Cross-platform Node.js utilities | ||
| mcp-configs/ — 14 MCP server configurations | ||
| tests/ — Test suite | ||
| ``` | ||
|
|
||
| ## 成功指标 | ||
|
|
||
| * 所有测试通过且覆盖率 80%+ | ||
| * 没有安全漏洞 | ||
| * 代码可读且可维护 | ||
| * 性能可接受 | ||
| * 满足用户需求 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # 更新日志 | ||
|
|
||
| ## 1.8.0 - 2026-03-04 | ||
|
|
||
| ### 亮点 | ||
|
|
||
| * 首次发布以可靠性、评估规程和自主循环操作为核心的版本。 | ||
| * Hook 运行时现在支持基于配置文件的控制和针对性的 Hook 禁用。 | ||
| * NanoClaw v2 增加了模型路由、技能热加载、分支、搜索、压缩、导出和指标功能。 | ||
|
|
||
| ### 核心 | ||
|
|
||
| * 新增命令:`/harness-audit`, `/loop-start`, `/loop-status`, `/quality-gate`, `/model-route`。 | ||
| * 新增技能: | ||
| * `agent-harness-construction` | ||
| * `agentic-engineering` | ||
| * `ralphinho-rfc-pipeline` | ||
| * `ai-first-engineering` | ||
| * `enterprise-agent-ops` | ||
| * `nanoclaw-repl` | ||
| * `continuous-agent-loop` | ||
| * 新增代理: | ||
| * `harness-optimizer` | ||
| * `loop-operator` | ||
|
|
||
| ### Hook 可靠性 | ||
|
|
||
| * 修复了 SessionStart 的根路径解析,增加了健壮的回退搜索。 | ||
| * 将会话摘要持久化移至 `Stop`,此处可获得转录负载。 | ||
| * 增加了质量门和成本追踪钩子。 | ||
| * 用专门的脚本文件替换了脆弱的单行内联钩子。 | ||
| * 增加了 `ECC_HOOK_PROFILE` 和 `ECC_DISABLED_HOOKS` 控制。 | ||
|
|
||
| ### 跨平台 | ||
|
|
||
| * 改进了文档警告逻辑中 Windows 安全路径的处理。 | ||
| * 强化了观察者循环行为,以避免非交互式挂起。 | ||
|
|
||
| ### 备注 | ||
|
|
||
| * `autonomous-loops` 作为一个兼容性别名保留一个版本;`continuous-agent-loop` 是规范名称。 | ||
|
|
||
| ### 鸣谢 | ||
|
|
||
| * 灵感来自 [zarazhangrui](https://github.com/zarazhangrui) | ||
| * homunculus 灵感来自 [humanplane](https://github.com/humanplane) |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,61 @@ | ||||||
| # CLAUDE.md | ||||||
|
|
||||||
| 本文件为 Claude Code (claude.ai/code) 处理此仓库代码时提供指导。 | ||||||
|
|
||||||
| ## 项目概述 | ||||||
|
|
||||||
| 这是一个 **Claude Code 插件** - 一个包含生产就绪的代理、技能、钩子、命令、规则和 MCP 配置的集合。该项目提供了使用 Claude Code 进行软件开发的经验证的工作流。 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid describing the repo as a single “插件”. This repository is presented here as a collection of agents, skills, commands, hooks, rules, and MCP configs, so calling it a single Claude Code plugin is misleading. ✏️ Suggested wording-这是一个 **Claude Code 插件** - 一个包含生产就绪的代理、技能、钩子、命令、规则和 MCP 配置的集合。该项目提供了使用 Claude Code 进行软件开发的经验证的工作流。
+这是一个 **Claude Code 资源集合**,包含生产就绪的代理、技能、钩子、命令、规则和 MCP 配置。该项目提供了使用 Claude Code 进行软件开发的经验证的工作流。📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
|
|
||||||
| ## 运行测试 | ||||||
|
|
||||||
| ```bash | ||||||
| # Run all tests | ||||||
| node tests/run-all.js | ||||||
|
|
||||||
| # Run individual test files | ||||||
| node tests/lib/utils.test.js | ||||||
| node tests/lib/package-manager.test.js | ||||||
| node tests/hooks/hooks.test.js | ||||||
| ``` | ||||||
|
|
||||||
| ## 架构 | ||||||
|
|
||||||
| 项目组织为以下几个核心组件: | ||||||
|
|
||||||
| * **agents/** - 用于委派的专业化子代理(规划器、代码审查员、TDD 指南等) | ||||||
| * **skills/** - 工作流定义和领域知识(编码标准、模式、测试) | ||||||
| * **commands/** - 由用户调用的斜杠命令(/tdd, /plan, /e2e 等) | ||||||
| * **hooks/** - 基于触发的自动化(会话持久化、工具前后钩子) | ||||||
| * **rules/** - 始终遵循的指南(安全、编码风格、测试要求) | ||||||
| * **mcp-configs/** - 用于外部集成的 MCP 服务器配置 | ||||||
| * **scripts/** - 用于钩子和设置的跨平台 Node.js 工具 | ||||||
| * **tests/** - 脚本和工具的测试套件 | ||||||
|
|
||||||
| ## 关键命令 | ||||||
|
|
||||||
| * `/tdd` - 测试驱动开发工作流 | ||||||
| * `/plan` - 实施规划 | ||||||
| * `/e2e` - 生成并运行端到端测试 | ||||||
| * `/code-review` - 质量审查 | ||||||
| * `/build-fix` - 修复构建错误 | ||||||
| * `/learn` - 从会话中提取模式 | ||||||
| * `/skill-create` - 从 git 历史记录生成技能 | ||||||
|
|
||||||
| ## 开发说明 | ||||||
|
|
||||||
| * 包管理器检测:npm、pnpm、yarn、bun(可通过 `CLAUDE_PACKAGE_MANAGER` 环境变量或项目配置设置) | ||||||
| * 跨平台:通过 Node.js 脚本支持 Windows、macOS、Linux | ||||||
| * 代理格式:带有 YAML 前言的 Markdown(名称、描述、工具、模型) | ||||||
| * 技能格式:带有清晰章节的 Markdown(何时使用、如何工作、示例) | ||||||
| * 钩子格式:带有匹配器条件和命令/通知钩子的 JSON | ||||||
|
|
||||||
| ## 贡献 | ||||||
|
|
||||||
| 遵循 CONTRIBUTING.md 中的格式: | ||||||
|
|
||||||
| * 代理:带有前言的 Markdown(名称、描述、工具、模型) | ||||||
| * 技能:清晰的章节(何时使用、如何工作、示例) | ||||||
| * 命令:带有描述前言的 Markdown | ||||||
| * 钩子:带有匹配器和钩子数组的 JSON | ||||||
|
|
||||||
| 文件命名:小写字母并用连字符连接(例如 `python-reviewer.md`, `tdd-workflow.md`) | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,84 @@ | ||||||
| # 贡献者公约行为准则 | ||||||
|
|
||||||
| ## 我们的承诺 | ||||||
|
|
||||||
| 作为成员、贡献者和领导者,我们承诺,无论年龄、体型、显性或隐性残疾、民族、性征、性别认同与表达、经验水平、教育程度、社会经济地位、国籍、外貌、种族、宗教或性取向如何,都努力使参与我们社区成为对每个人而言免受骚扰的体验。 | ||||||
|
|
||||||
| 我们承诺以有助于建立一个开放、友好、多元、包容和健康的社区的方式行事和互动。 | ||||||
|
|
||||||
| ## 我们的标准 | ||||||
|
|
||||||
| 有助于为我们社区营造积极环境的行为示例包括: | ||||||
|
|
||||||
| * 对他人表现出同理心和善意 | ||||||
| * 尊重不同的意见、观点和经验 | ||||||
| * 给予并优雅地接受建设性反馈 | ||||||
| * 承担责任,向受我们错误影响的人道歉,并从经验中学习 | ||||||
| * 关注不仅对我们个人而言是最好的,而且对整个社区而言是最好的事情 | ||||||
|
|
||||||
| 不可接受的行为示例包括: | ||||||
|
|
||||||
| * 使用性暗示的语言或图像,以及任何形式的性关注或性接近 | ||||||
| * 挑衅、侮辱或贬损性评论,以及个人或政治攻击 | ||||||
| * 公开或私下骚扰 | ||||||
| * 未经他人明确许可,发布他人的私人信息,例如物理地址或电子邮件地址 | ||||||
| * 其他在专业环境中可能被合理认为不当的行为 | ||||||
|
|
||||||
| ## 执行责任 | ||||||
|
|
||||||
| 社区领导者有责任澄清和执行我们可接受行为的标准,并将对他们认为不当、威胁、冒犯或有害的任何行为采取适当和公平的纠正措施。 | ||||||
|
|
||||||
| 社区领导者有权也有责任删除、编辑或拒绝与《行为准则》不符的评论、提交、代码、wiki 编辑、问题和其他贡献,并将在适当时沟通审核决定的原因。 | ||||||
|
|
||||||
| ## 适用范围 | ||||||
|
|
||||||
| 本《行为准则》适用于所有社区空间,也适用于个人在公共空间正式代表社区时。代表我们社区的示例包括使用官方电子邮件地址、通过官方社交媒体帐户发帖,或在在线或线下活动中担任指定代表。 | ||||||
|
|
||||||
| ## 执行 | ||||||
|
|
||||||
| 辱骂、骚扰或其他不可接受行为的实例可以向负责执行的社区领导者报告,邮箱为。 | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: Missing contact email address. The sentence says "邮箱为。" ("email is.") but no email address is provided. Either add the actual contact email or restructure the sentence (e.g., match the English phrasing that omits "email"). Prompt for AI agents
Suggested change
|
||||||
| 所有投诉都将得到及时和公正的审查和调查。 | ||||||
|
Comment on lines
+39
to
+40
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add an enforcement contact. The reporting path is incomplete here: the text says complaints can be sent by email, but no address is provided. As written, contributors have no way to report Code of Conduct violations. 🧰 Tools🪛 LanguageTool[uncategorized] ~40-~40: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:公正"地"审查 (wb4) 🤖 Prompt for AI Agents |
||||||
|
|
||||||
| 所有社区领导者都有义务尊重任何事件报告者的隐私和安全。 | ||||||
|
|
||||||
| ## 执行指南 | ||||||
|
|
||||||
| 社区领导者在确定他们认为违反本《行为准则》的任何行为的后果时,将遵循以下社区影响指南: | ||||||
|
|
||||||
| ### 1. 纠正 | ||||||
|
|
||||||
| **社区影响**:使用不当语言或社区认为不专业或不受欢迎的其他行为。 | ||||||
|
|
||||||
| **后果**:来自社区领导者的私人书面警告,阐明违规行为的性质并解释该行为为何不当。可能会要求进行公开道歉。 | ||||||
|
|
||||||
| ### 2. 警告 | ||||||
|
|
||||||
| **社区影响**:通过单一事件或一系列行为造成的违规。 | ||||||
|
|
||||||
| **后果**:带有持续行为后果的警告。在规定时间内,不得与相关人员互动,包括未经请求与执行《行为准则》的人员互动。这包括避免在社区空间以及社交媒体等外部渠道进行互动。违反这些条款可能导致暂时或永久封禁。 | ||||||
|
|
||||||
| ### 3. 暂时封禁 | ||||||
|
|
||||||
| **社区影响**:严重违反社区标准,包括持续的不当行为。 | ||||||
|
|
||||||
| **后果**:在规定时间内,禁止与社区进行任何形式的互动或公开交流。在此期间,不允许与相关人员进行公开或私下互动,包括未经请求与执行《行为准则》的人员互动。违反这些条款可能导致永久封禁。 | ||||||
|
|
||||||
| ### 4. 永久封禁 | ||||||
|
|
||||||
| **社区影响**:表现出违反社区标准的模式,包括持续的不当行为、骚扰个人,或对特定人群表现出攻击性或贬损。 | ||||||
|
|
||||||
| **后果**:永久禁止在社区内进行任何形式的公开互动。 | ||||||
|
|
||||||
| ## 归属 | ||||||
|
|
||||||
| 本《行为准则》改编自 \[Contributor Covenant]\[homepage], | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: Escaped brackets Prompt for AI agents
Suggested change
|
||||||
| 版本 2.0,可在 | ||||||
| https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html 获取。 | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: Escaped underscores in the URL ( Prompt for AI agents
Suggested change
|
||||||
|
|
||||||
| 社区影响指南的灵感来源于 [Mozilla 的行为准则执行阶梯](https://github.com/mozilla/diversity)。 | ||||||
|
|
||||||
| [homepage]: https://www.contributor-covenant.org | ||||||
|
|
||||||
| 有关本行为准则常见问题的解答,请参阅常见问题解答: | ||||||
| https://www.contributor-covenant.org/faq。翻译版本可在 | ||||||
| https://www.contributor-covenant.org/translations 获取。 | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The headline counts are stale and now contradict the zh-CN README.
This file still says
13/50+/33, whiledocs/zh-CN/README.mdnow advertises16 个智能体、65 项技能和 40 条命令. Please update both the intro and the project-structure block so the translated docs stay internally consistent.Also applies to: 125-127
🤖 Prompt for AI Agents