mcpField
C
copilotkit-contribute

copilotkit-contribute

github.com/copilotkit开发39599 次安装22 周前更新
代码仓库

关于 copilotkit-contribute

面向 CopilotKit 仓库贡献者的开发技能，介绍环境设置、开发、测试和 Pull Request 流程，并提供命令及 Monorepo 架构说明。

主要功能

  1. 01设置依赖并构建仓库
  2. 02开发和测试软件包
  3. 03运行 Lint 与格式检查
  4. 04遵循分支和提交规范
  5. 05了解 Monorepo 架构

适用场景

  1. 01开始参与 CopilotKit 开发
  2. 02提交 Pull Request 前运行测试
  3. 03查阅贡献流程和规范

MCP 相关

内含 `copilotkit-docs` MCP 服务，提供 `search-docs` 和 `search-code` 工具，用于查询 CopilotKit 文档与源码。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/copilotkit/skills --skill copilotkit-contribute

安装后在 Claude Code 中输入/copilotkit-contribute确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

sources.md
references/
contribution-guide.md
pr-guidelines.md
repo-structure.md
testing-guide.md

详细介绍

为 CopilotKit 做贡献

重要： CopilotKit 的内部 v2 软件包使用 @copilotkit/* 命名空间。用户安装的公共 API 使用 @copilotkit/*。贡献时，你使用 @copilotkit/* 源代码，但用户永远不会看到该命名空间。

实时文档（MCP）

此插件包含一个 MCP 服务（copilotkit-docs），提供 search-docs 和 search-code 工具，用于查询 CopilotKit 的实时文档和源代码。

  • Claude Code： 插件的 .mcp.json 会自动配置，无需设置。
  • Codex： 需要手动配置。设置说明请参阅 copilotkit-debug 技能。

工作流

  1. Fork 并克隆 CopilotKit/CopilotKit 仓库。
  2. 使用 pnpm install 安装依赖项（需要 pnpm v9.x 和 Node 20+）。
  3. 使用 pnpm build 构建一次，以引导所有软件包。
  4. 创建分支，并遵循以下命名约定：feat/<ISSUE>-<name>、fix/<ISSUE>-<name> 或 docs/<ISSUE>-<name>。
  5. 使用 pnpm dev 开发（监视所有软件包），或使用 nx run @copilotkit/<pkg>:dev 针对特定软件包。
  6. 使用 nx run @copilotkit/<pkg>:test 编写并运行测试。所有 v2 软件包都使用 Vitest。
  7. 使用 pnpm run lint --fix && pnpm run format 运行代码检查并格式化。
  8. 按照约定式提交格式 提交：<type>(<scope>): <subject>（由 commitlint 强制执行）。
  9. 推送并向 main 分支发起 PR。CI 会构建所有软件包，并通过 pkg-pr-new 发布预览软件包。

发起 PR 之前

  • 任何重要工作开始前，请先联系维护者（提交 issue 或在 Discord 上询问）。
  • 运行 pnpm run test，确认所有测试均通过。
  • 运行 pnpm run build，确认完整构建成功。
  • 运行 pnpm run check-prettier，确认格式正确。
  • 确保提交消息遵循 <type>(<scope>): <subject> 格式。

快速参考

任务命令
安装依赖项pnpm install
构建所有软件包pnpm build
开发模式（全部）pnpm dev
开发模式（仅 v2）pnpm dev:next
运行所有测试pnpm run test
仅运行 v2 测试pnpm test:next
运行单个软件包的测试nx run @copilotkit/core:test
测试并生成覆盖率报告pnpm run test:coverage
代码检查pnpm run lint
格式化pnpm run format
检查格式pnpm run check-prettier
类型检查pnpm run check-types
软件包质量检查pnpm run check:packages
依赖关系图pnpm run graph

关键架构要点

  • V2（@copilotkit/*）是真正的实现。V1（@copilotkit/*）封装了 V2。
  • 新功能始终添加到 packages/v2/ 下的 V2 软件包中。
  • 前端与运行时之间通过 AG-UI 协议（基于 SSE 的事件）进行通信。
  • 此单体仓库使用 Nx 进行任务编排，并使用 pnpm 工作区。

参考文档

评论

支持 Markdown