sakthivel-p-cse/codex/copilotkit-contribute

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

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.

Install

npx vskill@latest install sakthivel-p-cse/codex/copilotkit-contribute

SKILL.md

The same SKILL.md was published earlier as om-scogo/skillsh-scraper/copilotkit-contribute.

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

  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/<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

TaskCommand
Install dependenciespnpm install
Build all packagespnpm build
Dev mode (all)pnpm dev
Dev mode (v2 only)pnpm dev:next
Run all testspnpm run test
Run v2 tests onlypnpm test:next
Run single package testsnx run @copilotkit/core:test
Test with coveragepnpm run test:coverage
Lintpnpm run lint
Formatpnpm run format
Check formattingpnpm run check-prettier
Type checkpnpm run check-types
Package quality checkspnpm run check:packages
Dependency graphpnpm 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

Security

  • Security scanPassed, 90 of 100Pattern checks on the skill's files.
  • Model reviewPassed

See the full security report

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

See evaluation results

Source

Popularity

7-day trend score
0

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/sakthivel-p-cse/codex/copilotkit-contribute/badge)](https://verified-skill.com/skills/sakthivel-p-cse/codex/copilotkit-contribute)

Something wrong with this skill or its page? Tell us.