mcpField
C
copilotkit-contribute

copilotkit-contribute

github.com/copilotkit開発38.3k2.6k 回インストール今日更新
リポジトリ

copilotkit-contribute について

CopilotKitのコントリビューター向け開発スキルです。リポジトリの取得からビルド、テスト、PR作成までの手順に加え、アーキテクチャと確認コマンドを示し、最新ドキュメントとソースを検索するMCPサーバーも含みます。

主な機能

  1. 01リポジトリの開発ワークフローを説明
  2. 02ビルド、テスト、整形コマンドを提示
  3. 03v2の主要なアーキテクチャを解説
  4. 04PR前の確認項目を提供

活用シーン

  1. 01ローカルのCopilotKit開発環境を準備
  2. 02テスト実行とコード整形の確認
  3. 03CopilotKitの変更を準備して提出

MCP 対応

プラグインには、最新のCopilotKitドキュメントとソースコードを検索するsearch-docsおよびsearch-codeツールを備えたcopilotkit-docs MCPサーバーが含まれます。Claude Codeでは自動設定され、Codexでは手動設定が必要です。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/copilotkit/copilotkit --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）

このプラグインには、ライブの CopilotKit ドキュメントとソースコードを検索するための search-docs および search-code ツールを提供する MCP サーバー（copilotkit-docs）が含まれています。

  • Claude Code: プラグインの .mcp.json によって自動設定されるため、セットアップは不要です。
  • Codex: 手動での設定が必要です。セットアップ手順については、copilotkit-debug スキルをご覧ください。

ワークフロー

  1. 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. conventional commit 形式 <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 対応