Skip to content

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Aug 28, 2025

This PR adds a comprehensive .github/copilot-instructions.md file to onboard the repository to GitHub Copilot coding agents. The instructions provide everything a coding agent needs to work efficiently with the Devtron Dashboard codebase without extensive exploration.

What's included

Project Overview & Technology Stack

  • React 17.0.2 frontend with TypeScript and Vite build system
  • Yarn 4.9.2 package manager with Node.js v22 runtime
  • ESLint (Airbnb config) + Prettier code quality tools

Build Commands & Validation

  • Complete command reference with timing: yarn install (49s), yarn build (56s), yarn lint (3s)
  • Build variants for different environments (production, k8s, light builds)
  • Pre-commit hooks and GitHub CI workflow details

Project Structure & Architecture

  • Source code organization (src/Pages/, src/components/, src/services/)
  • TypeScript path aliases for clean imports (@Components/*, @Pages/*, etc.)
  • Key configuration files and their purposes

Quality Gates & Best Practices

  • Husky pre-commit hooks running TypeScript compilation and linting
  • GitHub CI workflow enforcing 0 ESLint warnings
  • Code organization rules and CSS guidelines (BEM methodology)

Troubleshooting Guide

  • Common build failures and memory issues
  • Development server problems and proxy configuration
  • Linting failures and import organization rules

Benefits for coding agents

  • Reduced exploration time: No need to search for build commands or project structure
  • Fewer failures: Clear validation steps and common error solutions
  • Better code quality: Explicit standards and best practices
  • Faster onboarding: Complete context in under 2 pages (1,222 words)

The instructions were validated by testing all documented commands and build processes to ensure accuracy.


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

Copy link

Some linked issues are invalid. Please update the issue links:\nIssue # in is not found or invalid (HTTP }404).\n

@github-actions github-actions bot added the PR:Issue-verification-failed PR:Issue-verification-failed label Aug 28, 2025
@Copilot 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 coding agent instructions Aug 28, 2025
Copilot finished work on behalf of arunjaindev August 28, 2025 08:23
@Copilot Copilot AI requested a review from arunjaindev August 28, 2025 08:23
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR:Issue-verification-failed PR:Issue-verification-failed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants