mcpField
C
copilotkit-contribute

copilotkit-contribute

github.com/copilotkit開発39599 回インストール22 週間前に更新
リポジトリ

copilotkit-contribute について

CopilotKit リポジトリに取り組む開発者向けの貢献ガイドスキルです。環境構築、開発、テスト、プルリクエストの手順を、コマンドやモノレポの構成説明とともに示します。

主な機能

  1. 01依存関係の導入とリポジトリのビルド
  2. 02パッケージの開発とテスト
  3. 03Lint とフォーマットの確認
  4. 04ブランチとコミット規約の順守
  5. 05モノレポ構成の確認

活用シーン

  1. 01CopilotKit 開発への参加準備
  2. 02プルリクエスト前のテスト実行
  3. 03貢献手順と規約の確認

MCP 対応

`copilotkit-docs` MCP サーバーを含み、CopilotKit のドキュメントやソースコードを検索する `search-docs` と `search-code` ツールを公開します。

インストール

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

$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）

このプラグインには、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 でLint とフォーマットを実行します。
  8. Conventional Commits 形式 <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
Lintpnpm 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 対応