Add comprehensive GitHub Copilot instructions for development workflow #247
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.
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the copilot-metrics-viewer codebase.What's Included
The instructions cover all essential development workflows with validated timing and command information:
Validated Commands & Timing
npm install
(3 minutes initial, 15 seconds subsequent)npm run build
(30 seconds with expected font provider warnings)npm test
(15 seconds, 83 tests pass)npm run dev
(starts successfully with mock data)npm run lint
(3 seconds, documents 43 existing errors)npm run typecheck
(9 seconds, documents 18 existing TypeScript errors)Critical Features
NUXT_SESSION_PASSWORD
/api/health
,/api/ready
,/api/live
)Manual Validation Scenarios
The instructions include specific test scenarios for:
Technical Details
All commands and scenarios have been thoroughly tested and validated to ensure the instructions work reliably for any developer starting fresh with the repository.
Fixes #246.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
api.fontshare.com
node /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/.bin/nuxt build
(dns block)node (vitest)
(dns block)/usr/local/bin/node --enable-source-maps /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/@nuxt/cli/bin/nuxi.mjs _dev
(dns block)api.fontsource.org
node /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/.bin/nuxt build
(dns block)node (vitest)
(dns block)/usr/local/bin/node --enable-source-maps /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/@nuxt/cli/bin/nuxi.mjs _dev
(dns block)fonts.bunny.net
node /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/.bin/nuxt build
(dns block)/home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js
(dns block)node (vitest)
(dns block)fonts.google.com
node /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/.bin/nuxt build
(dns block)node (vitest)
(dns block)/usr/local/bin/node --enable-source-maps /home/REDACTED/work/copilot-metrics-viewer/copilot-metrics-viewer/node_modules/@nuxt/cli/bin/nuxi.mjs _dev
(dns block)fonts.googleapis.com
node (vitest 1)
(dns block)node (vitest 2)
(dns block)node (vitest 3)
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.