Generate or update the .github/copilot-instructions.md file for this repository.
Instructions:
- •
Check if
.github/copilot-instructions.mdexists:- •Use the Read tool to check if the file exists
- •
If the file does NOT exist:
- •Explore the codebase using the Task tool with subagent_type=Explore
- •Focus on understanding:
- •Tech stack (frameworks, libraries, languages)
- •File naming conventions
- •Import patterns
- •Component/module structure patterns
- •Code style (formatting rules, linting config)
- •Testing approach
- •Key types and data structures
- •Common patterns to follow
- •Generate a comprehensive
.github/copilot-instructions.mdfile - •Write natural language instructions in Markdown format
- •Include critical conventions that developers must follow
- •Provide code examples for common patterns
- •
If the file DOES exist:
- •Read the existing
.github/copilot-instructions.mdfile - •Explore the codebase carefully using the Task tool with subagent_type=Explore
- •Identify:
- •New patterns or conventions not documented
- •Outdated information that needs updating
- •Missing important guidelines
- •Areas that need better examples
- •Update the file with improvements
- •Preserve existing good content
- •Add new sections for newly discovered patterns
- •Remove or update outdated information
- •Read the existing
- •
Content Guidelines:
- •Use clear, natural language
- •Focus on actionable patterns and conventions
- •Include code examples liberally
- •Highlight critical "must follow" rules
- •Reference key files to check for patterns
- •Keep instructions concise but comprehensive
- •Organize by topic (naming, imports, components, testing, etc.)
- •
After creating/updating:
- •Inform the user about what was created or changed
- •Highlight key conventions that were documented
- •Suggest reviewing the file before committing
Note: This creates GitHub Copilot custom instructions following the official format documented at https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions