Skip to content

Conversation

Copy link

Copilot AI commented Sep 1, 2025

Create comprehensive GitHub Copilot instructions for the Helpful Information repository.

✅ COMPLETED AND FULLY VALIDATED:

  • Explore repository structure and understand Angular/Ionic web application
  • Test and measure timing for all critical commands:
    • npm install: ~57 seconds
    • npm run setup: <1 second
    • npm run lint: ~16 seconds
    • npm run build: ~16 seconds
    • npm run build:production: ~16 seconds
    • npm test: ~50 seconds
  • Validate local development server functionality with local API
  • Verify production build and serving capabilities
  • Test complete user scenarios (navigation, page loading, data fetching)
  • Capture application screenshot for validation
  • ✅ Created .github/copilot-instructions.md with comprehensive setup and development guidelines
  • ✅ Include exact timing expectations and "NEVER CANCEL" warnings for builds
  • ✅ Document complete local development workflow (Google Sheets API + local JSON modes)
  • ✅ Include validation scenarios for testing application functionality
  • ✅ Add linting, building, and testing requirements for CI compatibility

🎯 Key Features of the Instructions:

✅ Firm Directive: Always reference instructions first, fallback to search only when needed

✅ Comprehensive Setup: Node.js v22 installation, npm install, and environment setup with exact commands

✅ Validated Timings: All commands tested with actual execution times:

  • npm install: 57s (timeout: 120s+)
  • npm build: 16s (timeout: 30s+)
  • npm test: 50s (timeout: 90s+)

✅ "NEVER CANCEL" Warnings: Explicit warnings with timeout recommendations for all long-running commands

✅ Dual Development Modes:

  1. Local JSON API (recommended): Uses test data in data/ directory
  2. Google Sheets API: Real API integration with Google Sheets

✅ Manual Validation Requirements: Complete user scenario testing including:

  • Navigation between pages
  • Category and offer browsing
  • Search functionality testing
  • Production build verification

✅ CI Compatibility: Exact linting and testing requirements to pass GitHub Actions workflows

✅ Known Issues Documentation: TypeScript and Stencil warnings that are non-blocking

✅ Architecture Overview: Key file locations, data flow, and project structure

📸 Application Successfully Running:

Helpful Information App Running

The instructions provide everything needed for a GitHub Copilot coding agent to work effectively in this codebase from a fresh clone. Every command has been exhaustively validated to work correctly with proper timing expectations.

🚀 Ready for use: The .github/copilot-instructions.md file contains all necessary information for any coding agent to successfully build, test, run, and navigate this Angular/Ionic web application.

Fixes #1188.


💡 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.

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