Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 7, 2025

Summary

Added comprehensive GitHub Copilot instructions to guide the AI coding assistant when working with code in this repository. This follows the best practices documented at gh.io/copilot-coding-agent-tips.

What's Changed

Created .github/copilot-instructions.md with 315 lines of guidance covering:

Core Content

  • Project Overview: Brief introduction to ComponentForge as an AI-powered React component generation tool
  • Development Environment: Quick start commands, manual setup, and testing procedures
  • Architecture: Detailed breakdown of the three-tier stack:
    • Frontend: Next.js 15.5.4 with App Router, TypeScript, shadcn/ui, Tailwind CSS v4
    • Backend: FastAPI, LangChain/LangGraph, SQLAlchemy with async PostgreSQL
    • Services: PostgreSQL, Qdrant vector DB, Redis via Docker Compose
  • Key Endpoints: Development server URLs for frontend, backend, and services
  • Environment Setup: Configuration guide for .env files
  • Tech Stack Dependencies: Comprehensive listing of all major libraries and tools organized by category (AI, Vector, Database, UI, State, Testing, Auth, Image)

Code Style & Patterns

Language-specific best practices for:

  • Frontend: Enhanced component library usage with 4-step discovery workflow, usage frequencies for base components (Button 60+ uses, Card 35+ uses), composite components list, TypeScript generics, form validation with Zod, and detailed state management patterns
  • Backend: Async/await patterns, Pydantic validation, dependency injection
  • Database: Async SQLAlchemy, Alembic migrations, Redis caching
  • AI/ML: LangChain/LangGraph workflows, LangSmith observability and tracing, confidence scoring, agent state management, and comprehensive error handling
  • Security: Input validation, sanitization, rate limiting, authentication and authorization flows

Critical Rules & Anti-Patterns

  • 21 critical rules covering component development, architecture decisions, and code quality
  • Anti-patterns organized by category: Component Development, Architecture, Code Quality, AI/ML, Performance
  • Special emphasis on component reuse (don't recreate existing UI components)
  • Enforces App Router over Pages Router (a common mistake to avoid)

Why This Matters

GitHub Copilot will now have context-aware guidance when:

  • Suggesting code completions
  • Generating new components or features
  • Refactoring existing code
  • Answering development questions

This ensures Copilot's suggestions align with the project's architecture, tech stack, and coding standards.

Source

Content adapted from the existing CLAUDE.md file and kept synchronized with the latest updates, optimized for GitHub Copilot's consumption format.

Resolves #61

Fixes #62

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #62

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: kchia <7776562+kchia@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions for repository configuration ✨ Set up GitHub Copilot instructions Oct 7, 2025
Copilot AI requested a review from kchia October 7, 2025 02:50
@kchia
Copy link
Owner

kchia commented Oct 7, 2025

@copilot can you look at recent updates in the repo and update instructions here if needed?

Co-authored-by: kchia <7776562+kchia@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Oct 7, 2025

@copilot can you look at recent updates in the repo and update instructions here if needed?

Updated the Copilot instructions to align with the latest CLAUDE.md content. Key additions include:

  • Tech Stack Dependencies section with comprehensive library listing (LangChain, LangGraph, LangSmith, axe-core, etc.)
  • Environment Setup and Key Endpoints sections repositioned earlier
  • Enhanced Component Discovery Workflow with detailed 4-step process
  • Expanded Base Components list with usage frequencies (Button 60+ uses, Card 35+ uses, etc.)
  • Added Composite Components section (RequirementCard, PatternCard, etc.)
  • More comprehensive AI/ML Patterns including LangSmith observability, confidence scoring, and agent state management
  • Enhanced Security Patterns with authentication/authorization flows

Commit: 66c9f53 → (new commit)

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