docs: add comprehensive GitHub Copilot instructions for efficient agent development #661
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a comprehensive
.github/copilot-instructions.mdfile 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:
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:Build Dependencies
Documents that
npm run buildmust 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 checkcommand: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:spellingValidation
All instructions have been thoroughly tested:
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.