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/diegoc1005/hackAI --skill copilotkit-contribute-diegoc1005
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: copilotkit-contribute
Source: https://github.com/diegoc1005/hackAI/tree/main/.cursor/skills/copilotkit-contribute
Command: npx skills add https://github.com/diegoc1005/hackAI --skill copilotkit-contribute-diegoc1005

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, 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: Covers forking, cloning, dependency installation with pnpm v9, building with Nx, branch naming conventions, and PR submission against CopilotKit/CopilotKit. - Testing and Quality Guidance: Explains the Vitest setup per package, coverage commands, lint/format checks, commitlint rules, and lefthook pre-commit hooks. - Architecture Reference: Documents the V1-wraps-V2 package structure, AG-UI protocol communication, and where new features belong (packages/v2/). - Use Case: You want to add a new React hook to CopilotKit. Use this Skill to set up the monorepo, create a properly named branch, run targeted tests with nx, and open a CI-compliant pull request. ## Quick Start Help me set up the CopilotKit repository locally and open a pull request for a bug fix in the runtime package.

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 CopilotKit/CopilotKit on GitHub, clone your fork, run pnpm install and pnpm build, then create a branch named feat/<ISSUE>-<name> or fix/<ISSUE>-<name>. After developing and testing, push and open a PR against the main branch.

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/react: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, style, 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 under packages/v1/ are wrappers around V2, so only add V1 code if backward compatibility requires a thin re-export.

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 an out-of-date lockfile; fix the reported issue rather than using --no-verify.