Skip to content

AGENTS.md

Latest commit

 

History

History
50 lines (37 loc) · 2.78 KB

AGENTS.md

File metadata and controls

50 lines (37 loc) · 2.78 KB
Raw

Guidelines for Contributors

This repository is a pnpm monorepo containing several packages under packages/ and a demo project in examples/. Each package is written in TypeScript and built with Vite. The examples/ app demonstrates how to integrate Vue CopilotKit into a Vue 3 application.

Repository overview

  • packages/vue-copilotkit is the recommended unified package for new integrations.
  • packages/vue-core and packages/vue-ui are deprecated compatibility packages and should generally not be the first choice for new documentation or examples.
  • examples/ is the primary local demo app and runtime integration reference.
  • Top-level README.md and README.zh.md are public-facing documents and must stay aligned.

Local setup

  • Use pnpm (pnpm@9.5.0) as the package manager.
  • Install dependencies with pnpm install.
  • Build all packages with pnpm build before committing to verify that the packages compile.
  • Node.js 18+ is recommended. Other versions may lead to type or build errors.
  • Start the example app with pnpm dev from the repository root.
  • Start the local CopilotKit runtime for the demo with pnpm -C examples dev:runtime.
  • Run pnpm typecheck when changes may affect TypeScript types across the workspace.

Coding conventions

  • Write concise, functional TypeScript. Prefer the Composition API over Options API.
  • Avoid classes and mutable global state.
  • Reuse utilities and components instead of duplicating code.
  • Keep file structures simple: the default export at the top, then helper functions and types.

Formatting

  • Format all changed files using Prettier. The configuration is defined in .prettierrc.cjs.
  • A typical command is npx prettier --write ..
  • Ensure source files are valid TypeScript and prefer the Composition API for Vue components.
  • Use PascalCase for component names and camelCase for functions and variables.
  • Folder names should use dash-case.

Documentation

  • Keep both README.md and README.zh.md updated when making documentation changes.
  • Prefer documenting the unified package @dingdayu/vue-copilotkit as the primary integration path.
  • When describing repository structure or setup, keep package status accurate: vue-copilotkit is active, vue-core and vue-ui are deprecated compatibility packages.
  • Keep command examples aligned with the actual workspace scripts (pnpm dev, pnpm -C examples dev:runtime, pnpm typecheck, pnpm build).
  • Public packages should include a README.md describing usage and exported APIs.

Commit style

  • Follow the Conventional Commits style used in this repository (e.g. feat:, fix:, chore:).
  • Commit messages should be in English and concise.
  • When adding features or fixes, update the corresponding packages/*/package.json version if publishing is needed.