How do I install the Copilotkit Contribute skill?

Run npx skillmds@latest add copilotkit/copilotkit-contribute in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Copilotkit Contribute safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Copilotkit Contribute?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Copilotkit Contribute free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Copilotkit Contribute?

copilotkit (@copilotkit) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Copilotkit Contribute by copilotkit

Name: Copilotkit Contribute
Rating: 4.2 (5 reviews)
Author: copilotkit

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.

copilotkit 752ec13 6 files · 24.1 KB Updated Sep 10, 2026

File contents

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

Fork and clone the CopilotKit/CopilotKit repository.
Install dependencies with pnpm install (requires pnpm v9.x and Node 20+).
Build once with pnpm build to bootstrap all packages.
Create a branch using the naming convention: feat/<ISSUE>-<name>, fix/<ISSUE>-<name>, or docs/<ISSUE>-<name>.
Develop with pnpm dev (watches all packages) or target a specific package with nx run @copilotkit/<pkg>:dev.
Write and run tests with nx run @copilotkit/<pkg>:test. All v2 packages use Vitest.
Lint and format with pnpm run lint --fix && pnpm run format.
Commit using conventional commit format: <type>(<scope>): <subject> (enforced by commitlint).
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

Task	Command
Install dependencies	`pnpm install`
Build all packages	`pnpm build`
Dev mode (all)	`pnpm dev`
Dev mode (v2 only)	`pnpm dev:next`
Run all tests	`pnpm run test`
Run v2 tests only	`pnpm test:next`
Run single package tests	`nx run @copilotkit/core:test`
Test with coverage	`pnpm run test:coverage`
Lint	`pnpm run lint`
Format	`pnpm run format`
Check formatting	`pnpm run check-prettier`
Type check	`pnpm run check-types`
Package quality checks	`pnpm run check:packages`
Dependency graph	`pnpm 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

Contribution Guide — full onboarding walkthrough
Repo Structure — package layout and architecture
Testing Guide — Vitest setup, running tests, coverage
PR Guidelines — CI checks, review process, expectations

---name: copilotkit-contributedescription: 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.---# 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](../copilotkit-debug/SKILL.md#mcp-setup) for setup instructions.## Workflow1. **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| Task | Command ||---|---|| Install dependencies | `pnpm install` || Build all packages | `pnpm build` || Dev mode (all) | `pnpm dev` || Dev mode (v2 only) | `pnpm dev:next` || Run all tests | `pnpm run test` || Run v2 tests only | `pnpm test:next` || Run single package tests | `nx run @copilotkit/core:test` || Test with coverage | `pnpm run test:coverage` || Lint | `pnpm run lint` || Format | `pnpm run format` || Check formatting | `pnpm run check-prettier` || Type check | `pnpm run check-types` || Package quality checks | `pnpm run check:packages` || Dependency graph | `pnpm 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- [Contribution Guide](references/contribution-guide.md) — full onboarding walkthrough- [Repo Structure](references/repo-structure.md) — package layout and architecture- [Testing Guide](references/testing-guide.md) — Vitest setup, running tests, coverage- [PR Guidelines](references/pr-guidelines.md) — CI checks, review process, expectations

Frequently asked questions