本文へ移動
cccskills
無料GitHub で公開

copilotkit-contribute

Use when contributing to the CopilotKit open-source project — forking, cloning, setting up the monorepo, creating branches, running tests, and submitting pull requests against CopilotKit/CopilotKit.

インストール方法を見る

含まれるファイル(6)

  • SKILL.md3.4 KB
  • references/contribution-guide.md3.7 KB
  • references/pr-guidelines.md3.7 KB
  • references/repo-structure.md6.0 KB
  • references/testing-guide.md4.8 KB
  • sources.md2.5 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Contributing to CopilotKit

Important: CopilotKit's internal v2 packages use the @copilotkit/* namespace. The public API that users install is @copilotkit/*. When contributing, you work with @copilotkit/* source but users never see that namespace.

Live Documentation (MCP)

This plugin includes an MCP server (copilotkit-docs) that provides search-docs and search-code tools for querying live CopilotKit documentation and source code.

  • Claude Code: Auto-configured by the plugin's .mcp.json -- no setup needed.
  • Codex: Requires manual configuration. See the copilotkit-debug skill for setup instructions.

Workflow

  1. Fork and clone the CopilotKit/CopilotKit repository.
  2. Install dependencies with pnpm install (requires pnpm v9.x and Node 20+).
  3. Build once with pnpm build to bootstrap all packages.
  4. Create a branch using the naming convention: feat/<ISSUE>-<name>, fix/<ISSUE>-<name>, or docs/<ISSUE>-<name>.
  5. Develop with pnpm dev (watches all packages) or target a specific package with nx run @copilotkit/<pkg>:dev.
  6. Write and run tests with nx run @copilotkit/<pkg>:test. All v2 packages use Vitest.
  7. Lint and format with pnpm run lint --fix && pnpm run format.
  8. Commit using conventional commit format: <type>(<scope>): <subject> (enforced by commitlint).
  9. Push and open a PR against the main branch. CI builds all packages and publishes preview packages via pkg-pr-new.

Before Opening a PR

  • Reach out to the maintainers first for any significant work (file an issue or ask on Discord).
  • Run pnpm run test to verify all tests pass.
  • Run pnpm run build to verify the full build succeeds.
  • Run pnpm run check-prettier to verify formatting.
  • Ensure commit messages follow the <type>(<scope>): <subject> format.

Quick Reference

TaskCommand
Install dependenciespnpm install
Build all packagespnpm build
Dev mode (all)pnpm dev
Dev mode (v2 only)pnpm dev:next
Run all testspnpm run test
Run v2 tests onlypnpm test:next
Run single package testsnx run @copilotkit/core:test
Test with coveragepnpm run test:coverage
Lintpnpm run lint
Formatpnpm run format
Check formattingpnpm run check-prettier
Type checkpnpm run check-types
Package quality checkspnpm run check:packages
Dependency graphpnpm run graph

Key Architecture Points

  • V2 (@copilotkit/*) is the real implementation. V1 (@copilotkit/*) wraps V2.
  • New features always go in V2 packages under packages/v2/.
  • Communication between frontend and runtime uses the AG-UI protocol (SSE-based events).
  • The monorepo uses Nx for task orchestration and pnpm workspaces.

Reference Documents

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

DEPRECATED: This skill has been replaced by `mcp-app-builder`. Check if `mcp-app-builder` is available in the skills folder. If not, install it: `npx skills install mcp-use/mcp-use --skill mcp-app-builder` Use `mcp-app-builder` instead of this skill. Build ChatGPT apps with interactive widgets using mcp-use and OpenAI Apps SDK. Use when creating ChatGPT apps, building MCP servers with widgets, defining React widgets, working with Apps SDK, or when user mentions ChatGPT widgets, mcp-use widgets, or Apps SDK development.

日本語の概要は準備中です。原文の説明を表示しています。

CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit72026年5月27日 更新

Use when building custom agent backends, implementing the AG-UI protocol, debugging streaming issues, or understanding how agents communicate with frontends. Covers event types, SSE transport, AbstractAgent/HttpAgent patterns, state synchronization, tool calls, and human-in-the-loop flows.

日本語の概要は準備中です。原文の説明を表示しています。

CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit72026年5月27日 更新

Use when diagnosing CopilotKit issues -- runtime connectivity failures, agent not responding, streaming errors, tool execution problems, transcription failures, version mismatches, and AG-UI event tracing.

日本語の概要は準備中です。原文の説明を表示しています。

CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit72026年5月27日 更新

Use when building AI-powered features with CopilotKit v2 -- adding chat interfaces, registering frontend tools, sharing application context with agents, handling agent interrupts, and working with the CopilotKit runtime.

日本語の概要は準備中です。原文の説明を表示しています。

CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit72026年5月27日 更新

Use when wiring an external agent framework (LangGraph, CrewAI, PydanticAI, Mastra, ADK, LlamaIndex, Agno, Strands, Microsoft Agent Framework, or others) into a CopilotKit application via the AG-UI protocol.

日本語の概要は準備中です。原文の説明を表示しています。

CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit72026年5月27日 更新

Use when the user wants to update, refresh, or reinstall the CopilotKit agent SKILLS (the SKILL.md files that teach this agent about CopilotKit). NOT for updating the CopilotKit codebase or project — this is specifically about refreshing the skills/knowledge this agent has loaded. Triggers on "update copilotkit skills", "update skills", "refresh skills", "skills are stale", "skills are outdated", "get latest skills", "my copilotkit knowledge is wrong", "copilotkit APIs changed", "skills seem old", "wrong API names", "reinstall skills", "skills not working right", "update your copilotkit knowledge".

日本語の概要は準備中です。原文の説明を表示しています。

CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit72026年5月27日 更新

CopilotKit のスキルをすべて見る

このスキルの問題を報告する