# Copilotkit Contribute

> >

- **Type:** Skill
- **Install:** `agentstack add skill-copilotkit-skills-copilotkit-contribute`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [CopilotKit](https://agentstack.voostack.com/s/copilotkit)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [CopilotKit](https://github.com/CopilotKit)
- **Source:** https://github.com/CopilotKit/skills/tree/main/skills/copilotkit-contribute

## Install

```sh
agentstack add skill-copilotkit-skills-copilotkit-contribute
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# 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.

## 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/-`, `fix/-`, or `docs/-`.
5. **Develop** with `pnpm dev` (watches all packages) or target a specific package with `nx run @copilotkit/:dev`.
6. **Write and run tests** with `nx run @copilotkit/:test`. All v2 packages use Vitest.
7. **Lint and format** with `pnpm run lint --fix && pnpm run format`.
8. **Commit** using conventional commit format: `(): ` (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 `(): ` 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

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [CopilotKit](https://github.com/CopilotKit)
- **Source:** [CopilotKit/skills](https://github.com/CopilotKit/skills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-copilotkit-skills-copilotkit-contribute
- Seller: https://agentstack.voostack.com/s/copilotkit
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.