Guidelines for creating high-quality custom instruction files for GitHub Copilot
# Custom Instructions File Guidelines Instructions for creating effective and maintainable custom instruction files that guide GitHub Copilot in generating domain-specific code and following project conventions. ## Project Context - Target audience: Developers and GitHub Copilot working with domain-specific code - File format: Markdown with YAML frontmatter - File naming convention: lowercase with hyphens (e.g., `react-best-practices.instructions.md`) - Location: `.github/instructions/` directory - Purpose: Provide context-aware guidance for code generation, review, and documentation ## Required Frontmatter Every instruction file must include YAML frontmatter with the following fields: ```yaml --- description: 'Brief description of the instruction purpose and scope' applyTo: 'glob pattern for target files (e.g., **/*.ts, **/*.py)' --- ``` ### Frontmatter Guidelines
Sign in to view the full prompt.
Sign In