Back to Skills

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.

36,390stars4,496forksUpdated 8/1/2026

Security Assessment

Safe(95/100)
Security Score95/100

About copilotkit-contribute

CopilotKit Contribute is an onboarding and workflow skill for contributing to the CopilotKit open-source project. It solves the friction of getting a new contributor productive in a large pnpm/Nx monorepo by documenting the full path from fork and clone through setup, branching, testing, and submitting a pull request against CopilotKit/CopilotKit. It also references a bundled MCP server (copilotkit-docs) that exposes search-docs and search-code tools for querying live documentation and source.

The skill lays out a concrete workflow: fork and clone, install with pnpm (requires pnpm v9.x and Node 20+), bootstrap with a single build, create a branch using feat/fix/docs naming conventions, develop with watch mode or a targeted Nx package task, run Vitest tests, lint and format, commit using enforced conventional-commit format, and open a PR against main where CI builds all packages and publishes preview packages. It includes a pre-PR checklist, a quick-reference command table, key architecture notes (the V1-wraps-V2 package structure, the AG-UI SSE-based protocol between frontend and runtime, and Nx/pnpm orchestration), and reference documents covering repo structure, the testing guide, PR guidelines, and pre-commit hooks (lefthook running lint-fix, tests, package checks, and commitlint).

It targets developers who want to contribute to CopilotKit and need the project's specific conventions, commands, and CI expectations in one place. All commands are standard local development operations (git, pnpm, nx) with no destructive or remote-execution behavior.

FAQ

What are the prerequisites for building the project?

pnpm v9.x and Node 20+. You install dependencies with pnpm install, then run pnpm build once to bootstrap all packages before developing.

What must pass before opening a PR?

Run pnpm run test (tests), pnpm build (full build), and pnpm run check-prettier (formatting), and ensure every commit follows the conventional <type>(<scope>): <subject> format enforced by commitlint. Package quality is checked with pnpm run check:packages.

How is the codebase structured?

It is a pnpm monorepo orchestrated by Nx. V2 packages under packages/v2/ are the real implementation; V1 packages are the public API that wraps V2. New features always go in V2. Frontend, runtime, and agent layers communicate over the SSE-based AG-UI protocol.

Is there live documentation available while contributing?

Yes. The plugin includes an MCP server (copilotkit-docs) providing search-docs and search-code tools. It is auto-configured in Claude Code via the plugin's .mcp.json; Codex requires manual setup.

All Files

6 files
references/pr-guidelines.md4.1 KB
View
references/repo-structure.md9.3 KB
View
references/testing-guide.md4.8 KB
View
references/contribution-guide.md4.1 KB
View
SKILL.md3.8 KB
View
sources.md2.5 KB
View

Install copilotkit-contribute

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill