copilotkit-contribute

Guides forking, building, testing, and submitting pull requests to the CopilotKit monorepo.

Updated May 9, 2026
One-click install
npx skills add https://github.com/23wj1a0541/L.E.N.S --skill copilotkit-contribute-23wj1a0541
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: copilotkit-contribute
Source: https://github.com/23wj1a0541/L.E.N.S/tree/main/.cursor/skills/copilotkit-contribute
Command: npx skills add https://github.com/23wj1a0541/L.E.N.S --skill copilotkit-contribute-23wj1a0541

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Contributing to the CopilotKit open-source project requires navigating a pnpm/Nx monorepo with V1/V2 package layers, conventional commit rules, lefthook pre-commit hooks, and CI checks. This Skill consolidates the entire contribution workflow so you avoid setup mistakes and rejected PRs. ## Core Features & Use Cases - End-to-End Contribution Workflow: Step-by-step guidance from forking and cloning through branch naming, development, testing, and PR submission. - Command Reference: Quick lookup table for pnpm and Nx commands covering install, build, dev mode, tests, coverage, lint, and type checks. - Architecture Orientation: Explains the V1-wraps-V2 package structure, AG-UI protocol communication, and where new features belong. - Use Case: You want to fix a bug in the CopilotKit runtime. The Skill walks you through creating a fix/<ISSUE>-<name> branch, running nx run @copilotkit/runtime:test, formatting commits per commitlint rules, and passing CI before opening the PR. ## Quick Start Ask the agent to walk you through setting up a CopilotKit fork and running the v2 core package tests before opening your first pull request.

Frequently Asked Questions about copilotkit-contribute

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I contribute to the CopilotKit open-source project?▼

Fork and clone CopilotKit/CopilotKit, run pnpm install and pnpm build, then create a branch named feat/<ISSUE>-<name> or fix/<ISSUE>-<name>. Develop with pnpm dev, test with Vitest, and open a PR against main after CI checks pass.

How do I run tests for a single CopilotKit package?▼

Use Nx with the package name, for example nx run @copilotkit/core:test or nx run @copilotkit/runtime:test. All v2 packages use Vitest, and tests depend on upstream packages being built first.

What commit message format does CopilotKit require?▼

CopilotKit enforces conventional commits via commitlint: <type>(<scope>): <subject> with a 120-character header limit. Valid types include feat, fix, docs, refactor, perf, test, and chore, with the scope being the package name.

Where should new CopilotKit features be implemented, V1 or V2?▼

New features always go in V2 packages under packages/v2/, which contain the real implementation. V1 packages wrap V2 internally, so only add V1 wrappers when backward compatibility is needed.

Why do CopilotKit pre-commit hooks fail on my commit?▼

Lefthook runs check-binaries, sync-lockfile, lint-fix, and test-and-check-packages in parallel on every commit. Failures usually come from lint errors, failing tests, oversized files, or a stale lockfile; fix the issue rather than using --no-verify.