mcpField
C
copilotkit-contribute

copilotkit-contribute

github.com/copilotkitDevelopment38.3k2.6k installsUpdated today
Repository

About copilotkit-contribute

A development skill for CopilotKit contributors, covering the workflow from cloning and building through testing and opening a PR. It also outlines architecture and check commands, and includes an MCP server for searching live documentation and source code.

Key features

  1. 01Outlines the repository development workflow
  2. 02Lists build, test, and formatting commands
  3. 03Describes key v2 architecture points
  4. 04Provides a pre-PR checklist

Use cases

  1. 01Setting up a local CopilotKit development environment
  2. 02Running tests and checking formatting
  3. 03Preparing and submitting CopilotKit changes

MCP support

The plugin includes the copilotkit-docs MCP server with search-docs and search-code tools for querying live CopilotKit documentation and source code. It is auto-configured for Claude Code; Codex requires manual setup.

Install

Copy the command and run it in a terminal.

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

After installing, type/copilotkit-contributein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

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

Details

From the project README

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

Comments

Markdown supported