Add comprehensive GitHub Copilot instructions for source-map-parser-mcp#24
Add comprehensive GitHub Copilot instructions for source-map-parser-mcp#24
Conversation
Co-authored-by: MasonChow <[email protected]>
Co-authored-by: MasonChow <[email protected]>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24 +/- ##
=======================================
Coverage 17.64% 17.64%
=======================================
Files 5 5
Lines 340 340
Branches 20 20
=======================================
Hits 60 60
Misses 278 278
Partials 2 2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive GitHub Copilot instructions for the source-map-parser-mcp project to help coding agents work effectively in the codebase from a fresh clone.
- Provides validated build and test commands with explicit timing expectations
- Documents critical workflow requirements including "NEVER CANCEL" warnings for build processes
- Establishes validation scenarios using example source maps for testing core MCP functionality
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/copilot-instructions.md | New comprehensive instructions file covering build commands, testing procedures, MCP tools, file locations, and validation scenarios |
| src/external/docs/guide.xml | Reorganization of file entries, moving cachingFetch.ts content earlier and reordering test files |
| - `npm install` -- takes ~1 second. Dependencies are already cached. | ||
| - `npm run build` -- takes ~4-5 seconds total. NEVER CANCEL. Set timeout to 30+ seconds. | ||
| - The build process includes: | ||
| - `npm run build:vite` (Vite build ~1.3 seconds) |
There was a problem hiding this comment.
Missing space after hyphen in bullet point. Should be '- npm run build:vite' for consistency with other bullet points in the document.
| - `npm run test:ci` -- takes ~11 seconds total. NEVER CANCEL. Set timeout to 30+ seconds. | ||
| - Memory cache tests: 8 tests pass in <1 second | ||
| - Client test: Currently times out after 10 seconds (known issue - integration test configuration) |
There was a problem hiding this comment.
The timing information is inconsistent. Line 18 states the test takes ~11 seconds, but line 119 states 'Test (working tests): <1 second'. This discrepancy could confuse users about expected test duration.
| - `npm run test:ci` -- takes ~11 seconds total. NEVER CANCEL. Set timeout to 30+ seconds. | |
| - Memory cache tests: 8 tests pass in <1 second | |
| - Client test: Currently times out after 10 seconds (known issue - integration test configuration) | |
| - `npm run test:ci` -- takes ~11 seconds total (due to client test timeout). NEVER CANCEL. Set timeout to 30+ seconds. | |
| - Memory cache tests: 8 tests pass in <1 second | |
| - Client test: Takes ~10 seconds due to timeout (known issue - integration test configuration) |
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions for working effectively in this codebase.What's Included
The instructions cover all essential aspects for a coding agent working from a fresh clone:
Build & Test Commands (All Validated):
npm install(~1 second)npm run build(~4-5 seconds total, includes Vite build + repomix documentation)npx vitest run tests/memoryCacheManager.test.ts(<1 second, 8 tests pass)Critical Timing & Timeout Requirements:
Functionality Validation Scenarios:
operating_guideandparse_stackRepository Navigation:
Validation Performed
Every command and scenario in the instructions was thoroughly validated:
The instructions emphasize that the client test timeout (10+ seconds) is a known configuration issue and not indicative of broken functionality, preventing agents from wasting time on this non-critical issue.
Fixes #23.
💡 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.