Skip to content

Add .github/copilot-instructions.md for AI agent onboarding#100

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-copilot-instructions
Draft

Add .github/copilot-instructions.md for AI agent onboarding#100
Copilot wants to merge 2 commits intomainfrom
copilot/add-copilot-instructions

Conversation

Copy link

Copilot AI commented Feb 16, 2026

Creates comprehensive onboarding documentation for AI coding agents working with this React component library.

File Structure

.github/copilot-instructions.md (481 lines):

  • Project context: TypeScript-first React 18 component library with server/client component architecture
  • Tech stack: React 19, TypeScript 5.7, Tailwind CSS 3.4, tsup/tsc build, Vitest testing, Storybook docs
  • Critical constraints:
    • Must use pnpm 10.9.0 (not npm/yarn)
    • Storybook runs in Docker (don't start locally)
    • Server actions must separate from client components
  • Build process: Dual tsup (bundling) + tsc (types) with directive preservation
  • Known issues documented:
    • TypeScript errors in example files (excluded from build, ignorable)
    • 11 pre-existing test failures (don't fix unless related)
    • pnpm installation requirement
    • Server/client directive conflicts with solutions
  • Development patterns: Component creation workflow, export chain, testing with @testing-library/react
  • Architecture decisions: Why two CSS files (styles.css vs globals.css), separate server exports, tsup+tsc rationale

Key Sections

  • Package manager requirements and installation
  • Essential commands: pnpm run build && pnpm run typecheck && pnpm run test
  • Project structure with path aliases
  • Styling system (Tailwind preset for consumers)
  • Common pitfalls with solutions
  • Quick reference commands
  • AI agent checklist

All errors encountered during exploration are documented with workarounds per the requirements.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: rob-at-cortex <50111225+rob-at-cortex@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot agent onboarding instructions Add .github/copilot-instructions.md for AI agent onboarding Feb 16, 2026
Copilot AI requested a review from rob-at-cortex February 16, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants