copilotkit-contribute

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

7|3|Updated May 8, 2026
One-click install
npx skills add https://github.com/CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit --skill copilotkit-contribute-copilotkit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: copilotkit-contribute
Source: https://github.com/CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit/tree/main/.cursor/skills/copilotkit-contribute
Command: npx skills add https://github.com/CopilotKit/Generative-UI-Global-Hackathon-Starter-Kit --skill copilotkit-contribute-copilotkit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Contributing to the CopilotKit open-source monorepo requires knowing its pnpm/Nx workspace layout, V1-wraps-V2 package architecture, Vitest setup, conventional commit rules, and PR process — this Skill consolidates that workflow into one guided reference. ## Core Features & Use Cases - End-to-end contribution workflow: Covers forking, cloning, dependency installation with pnpm v9, Nx-based builds, branch naming conventions, and PR submission against CopilotKit/CopilotKit. - Testing and quality gates: Documents Vitest configuration per package, coverage commands, lefthook pre-commit hooks, commitlint enforcement, and CI preview publishing via pkg-pr-new. - Architecture orientation: Explains the V2-first development model, AG-UI protocol communication, and the full package layout so contributors know where new code belongs. - Use Case: A developer wants to add a feature to CopilotKit. The Skill walks them through creating a feat/<ISSUE>-<name> branch, adding code in packages/v2/, running nx run @copilotkit/core:test, and opening a compliant PR. ## Quick Start Help me set up the CopilotKit repository locally and create a properly named branch for my first contribution.

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, create a branch named feat/<ISSUE>-<name> or fix/<ISSUE>-<name>, develop with pnpm dev, run tests, and open a PR against main with conventional commit messages.

How do I run tests in the CopilotKit monorepo?▼

Run pnpm run test for all packages, pnpm test:next for V2 only, or nx run @copilotkit/core:test for a single package. All packages use Vitest with globals enabled, 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 public API wrappers, and V1 changes are only needed for backward compatibility.

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 issue rather than using --no-verify.