大模型应用
为 CopilotKit 开源项目贡献代码时:从 fork…
当你需要向 CopilotKit/CopilotKit 仓库贡献改动并走完开发、测试、PR 流程时使用。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 38/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 55/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 59/100 ×0.15
适用场景
为 CopilotKit 开源项目贡献代特定
解决思路
- MCP:插件包含 `copilotkit-docs` MCP server,提供 `search-docs` 和 `search-code` 工具,用于查询实时 CopilotKit 文档和源码。
- MCP:在 Claude Code 中,插件通过 `.mcp.json` 自动配置,无需额外设置。
- MCP:在 Codex 中需要手动配置,参考 copilotkit-debug skill 的 MCP setup 说明。
- Fork 并 clone `CopilotKit/CopilotKit` 仓库。
- 用 `pnpm install` 安装依赖(需要 pnpm v9.x 和 Node 20+)。
- 先运行一次 `pnpm build` 来 bootstrap 所有包。
- 按命名约定创建分支:`feat/<ISSUE>-<name>`、`fix/<ISSUE>-<name>` 或 `docs/<ISSUE>-<name>`。
- 用 `pnpm dev` 开发(监听所有包),或用 `nx run @copilotkit/<pkg>:dev` 针对特定包开发。
- 用 `nx run @copilotkit/<pkg>:test` 编写并运行测试;所有 v2 包使用 Vitest。
- 用 `pnpm run lint --fix && pnpm run format` 做 lint 和格式化。
- 使用 conventional commit 格式提交:`<type>(<scope>): <subject>`(由 commitlint 强制执行)。
- Push 并针对 `main` 分支打开 PR;CI 会构建所有包并通过 pkg-pr-new 发布预览包。
- 对任何重要工作,在开 PR 前先联系维护者(提交 issue 或在 Discord 提问)。
- 开 PR 前运行 `pnpm run test` 验证所有测试通过。
- 开 PR 前运行 `pnpm run build` 验证完整构建成功。
- 开 PR 前运行 `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`。
- 快速参考:Lint 使用 `pnpm run lint`。
- 快速参考:Format 使用 `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 包中。
- 架构:前端和 runtime 之间使用 AG-UI 协议(基于 SSE 的事件)通信。
- 架构:monorepo 使用 Nx 进行任务编排,并使用 pnpm workspaces。
- 参考文档:Contribution Guide `references/contribution-guide.md` 是完整入门走查。
- 参考文档:Repo Structure `references/repo-structure.md` 说明包布局和架构。
- 参考文档:Testing Guide `references/testing-guide.md` 说明 Vitest 设置、运行测试和覆盖率。
- 参考文档:PR Guidelines `references/pr-guidelines.md` 说明 CI 检查、审查流程和期望。
适用边界 · 注意事项
- 不适用于向非 CopilotKit 的项目贡献代码。
- 不适用于只想使用 CopilotKit 公共 API、不需要修改仓库源码的场景。
- 不适用于无法使用 pnpm v9.x、Node 20+、Nx 或 Git 的环境。