Skip to content

Conversation

Copy link

Copilot AI commented Sep 22, 2025

This PR adds a comprehensive .github/copilot-instructions.md file to help coding agents work more efficiently with this repository by providing essential information upfront, reducing exploration time and preventing build failures.

What was added

The instructions document provides:

  • Repository overview: Clear description of the browser-based LLM chat application, its serverless architecture, and local IndexedDB storage
  • Complete build guide: All necessary commands with verified timings and expected outputs
  • Project architecture: Detailed breakdown of the React + TypeScript + Vite stack with key file locations
  • Known issues documentation: Current linting errors, test failures, and build warnings with explanations

Key benefits for agents

  1. Prevents common mistakes: Documents that linting issues are non-blocking and that pnpm (not npm) must be used
  2. Sets proper expectations: Explains that tests currently fail due to RouterProvider/IndexedDB mocking issues
  3. Reduces exploration time: Provides comprehensive file structure and component organization details
  4. Improves success rate: Documents the exact command sequence and timing expectations for builds

Example of critical information included

The instructions clearly state upfront that:

  • Build warnings about large chunks (>500KB) are expected due to syntax highlighting dependencies
  • Current linting errors in UI components are known issues that don't block builds
  • The application is entirely client-side with no server setup required
  • All data is stored locally in IndexedDB using Dexie

This documentation will significantly reduce the likelihood of agent PRs being rejected due to misunderstanding the project structure, build process, or attempting to "fix" known non-blocking issues.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@vercel
Copy link

vercel bot commented Sep 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
browser-chat-llm Ready Ready Preview Comment Sep 22, 2025 10:08am

Co-authored-by: salindae25 <8200073+salindae25@users.noreply.github.com>
Copilot AI changed the title [WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. You wi... Add comprehensive Copilot instructions for efficient agent development Sep 22, 2025
Copilot AI requested a review from salindae25 September 22, 2025 10:08
Copilot finished work on behalf of salindae25 September 22, 2025 10:08
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.

2 participants