Skip to content

Add comprehensive GitHub Copilot instructions for Q-isms development workflow#4

Open
Copilot wants to merge 2 commits intomainfrom
copilot/fix-3
Open

Add comprehensive GitHub Copilot instructions for Q-isms development workflow#4
Copilot wants to merge 2 commits intomainfrom
copilot/fix-3

Conversation

Copy link

Copilot AI commented Sep 3, 2025

Created .github/copilot-instructions.md with exhaustively validated instructions for GitHub Copilot coding agents working on the Q-isms repository.

What was added

The instructions provide comprehensive guidance for:

  • Bootstrap and development: Exact commands with measured timing expectations
  • Build validation: Complete build, test, and deployment workflows
  • Functional testing: End-to-end user scenarios including quote display, dark mode toggle, and interactive features
  • Architecture overview: File structure, dependencies, and key components
  • Troubleshooting: Expected vs problematic errors with specific solutions

Key features

  • Firm directive: Instructs agents to follow these instructions first before searching
  • Imperative tone: Clear "Run this command" / "Do not do this" guidance
  • NEVER CANCEL warnings: Explicit timeout values (120-180+ seconds) for all build operations
  • Expected behaviors: Documents font provider warnings as normal due to network restrictions
  • Complete validation scenarios: Requires testing quote refresh, dark mode, and navigation after changes

Validation performed

All instructions were validated through:

  • Clean environment testing (removed node_modules, reinstalled from scratch)
  • Measured actual timing: npm install (1-2 minutes), build (15-25 seconds), dev server (10-20 seconds)
  • End-to-end functional testing with screenshots of working application
  • Verification that font provider errors are cosmetic and don't affect functionality

The Q-isms application is a Nuxt.js 3 web app displaying random quotes from Q (Tony) with animated fox characters, dark mode support, and beautiful gradient styling. The instructions ensure any coding agent can quickly become productive working on this codebase.

Screenshots show the application working correctly in both light mode (https://github.com/user-attachments/assets/ff88a4c9-8c8e-4f7d-b8ae-79cd3961073f) and dark mode (https://github.com/user-attachments/assets/9d3513f5-835a-4cd7-9451-d300d008360e), demonstrating the validation scenarios described in the instructions.

Fixes #3.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • api.fontshare.com
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt build (dns block)
    • Triggering command: /usr/local/bin/node --enable-source-maps /home/REDACTED/work/Q-isms/Q-isms/node_modules/nuxi/bin/nuxi.mjs _dev (dns block)
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt dev (dns block)
  • api.fontsource.org
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt build (dns block)
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt generate (dns block)
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt dev (dns block)
  • api.iconify.design
    • Triggering command: /usr/local/bin/node --enable-source-maps /home/REDACTED/work/Q-isms/Q-isms/node_modules/nuxi/bin/nuxi.mjs _dev (dns block)
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt dev (dns block)
  • fonts.bunny.net
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt build (dns block)
    • Triggering command: /usr/local/bin/node --enable-source-maps /home/REDACTED/work/Q-isms/Q-isms/node_modules/nuxi/bin/nuxi.mjs _dev (dns block)
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt generate (dns block)
  • fonts.google.com
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt build (dns block)
    • Triggering command: /usr/local/bin/node --enable-source-maps /home/REDACTED/work/Q-isms/Q-isms/node_modules/nuxi/bin/nuxi.mjs _dev (dns block)
    • Triggering command: node /home/REDACTED/work/Q-isms/Q-isms/node_modules/.bin/nuxt generate (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 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 Sep 3, 2025

Deploy Preview for qisms failed.

Name Link
🔨 Latest commit 49bcf80
🔍 Latest deploy log https://app.netlify.com/projects/qisms/deploys/68b856666c1f720008adf34b

@thewebbeckons thewebbeckons marked this pull request as ready for review September 3, 2025 14:48
@nuxthub-admin
Copy link
Contributor

nuxthub-admin bot commented Sep 3, 2025

❌ Deployment failed q-isms

Failed to deploy q-isms 69b2891 to preview

📋 View deployment logs

Co-authored-by: thewebbeckons <3504767+thewebbeckons@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for Q-isms development workflow Sep 3, 2025
Copilot AI requested a review from thewebbeckons September 3, 2025 14:54
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.

✨ Set up Copilot instructions

2 participants