Skip to content

Conversation

Copy link

Copilot AI commented Aug 26, 2025

Adds a comprehensive .github/copilot-instructions.md file to help GitHub Copilot coding agents work efficiently with the xstate-audition repository without extensive exploration.

What This Adds

The instructions file provides coding agents with essential repository information including:

  • Repository Overview: Description of xstate-audition as a dependency-free TypeScript library for testing XState v5+ Actors, with architecture details and target runtime requirements
  • Complete Build & Validation Workflow: Step-by-step instructions for setup, building, testing, linting, and type checking with correct command sequences
  • Project Layout: Detailed source structure, test organization, and configuration file locations
  • Critical Issue Documentation: Fixes for known problems like the test script glob pattern issue in package.json

Key Problems Solved

Test Command Fix

The package.json test script uses "./test/*.spec.ts" which fails due to glob pattern handling. The instructions document the correct command:

node --test --import tsx test/*.spec.ts  # Works correctly

Build Dependencies

Documents that npm run build must always be run before linting since some lint rules check the file system for build outputs.

Complete Validation Sequence

Provides a tested sequence of commands that replaces the broken npm run check command:

npm run build
node --test --import tsx test/*.spec.ts
npm run test:types
npm run lint
npm run lint:knip
npm run lint:md
npm run lint:spelling

Validation

All instructions have been thoroughly tested:

  • ✅ Build process works correctly with tshy
  • ✅ Test commands run successfully with corrected glob pattern
  • ✅ All linting steps pass (ESLint, knip, markdown, spelling)
  • ✅ Type checking passes with TypeScript strict mode
  • ✅ Instructions file itself passes all quality checks

The instructions follow the 2-page limit while providing comprehensive coverage of the repository's development workflow, significantly reducing the time agents need to explore and understand the codebase structure.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@netlify
Copy link

netlify bot commented Aug 26, 2025

Deploy Preview for xstate-audition ready!

Name Link
🔨 Latest commit a392584
🔍 Latest deploy log https://app.netlify.com/projects/xstate-audition/deploys/68ae1a6830a9420008ed745a
😎 Deploy Preview https://deploy-preview-661--xstate-audition.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI changed the title [WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. You wi... docs: add comprehensive GitHub Copilot instructions for efficient agent development Aug 26, 2025
Copilot AI requested a review from boneskull August 26, 2025 20:35
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