|
| 1 | +--- |
| 2 | +agent: 'agent' |
| 3 | +description: 'Suggest relevant GitHub Copilot instruction files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing instructions in this repository, and identifying outdated instructions that need updates.' |
| 4 | +tools: ['edit', 'search', 'runCommands', 'runTasks', 'think', 'changes', 'testFailure', 'openSimpleBrowser', 'web/fetch', 'githubRepo', 'todos', 'search'] |
| 5 | +--- |
| 6 | +# Suggest Awesome GitHub Copilot Instructions |
| 7 | + |
| 8 | +Analyze current repository context and suggest relevant copilot-instruction files from the [GitHub awesome-copilot repository](https://github.com/github/awesome-copilot/blob/main/docs/README.instructions.md) that are not already available in this repository. |
| 9 | + |
| 10 | +## Process |
| 11 | + |
| 12 | +1. **Fetch Available Instructions**: Extract instruction list and descriptions from [awesome-copilot README.instructions.md](https://github.com/github/awesome-copilot/blob/main/docs/README.instructions.md). Must use `#fetch` tool. |
| 13 | +2. **Scan Local Instructions**: Discover existing instruction files in `.github/instructions/` folder |
| 14 | +3. **Extract Descriptions**: Read front matter from local instruction files to get descriptions and `applyTo` patterns |
| 15 | +4. **Fetch Remote Versions**: For each local instruction, fetch the corresponding version from awesome-copilot repository using raw GitHub URLs (e.g., `https://raw.githubusercontent.com/github/awesome-copilot/main/instructions/<filename>`) |
| 16 | +5. **Compare Versions**: Compare local instruction content with remote versions to identify: |
| 17 | + - Instructions that are up-to-date (exact match) |
| 18 | + - Instructions that are outdated (content differs) |
| 19 | + - Key differences in outdated instructions (description, applyTo patterns, content) |
| 20 | +6. **Analyze Context**: Review chat history, repository files, and current project needs |
| 21 | +7. **Compare Existing**: Check against instructions already available in this repository |
| 22 | +8. **Match Relevance**: Compare available instructions against identified patterns and requirements |
| 23 | +9. **Present Options**: Display relevant instructions with descriptions, rationale, and availability status including outdated instructions |
| 24 | +10. **Validate**: Ensure suggested instructions would add value not already covered by existing instructions |
| 25 | +11. **Output**: Provide structured table with suggestions, descriptions, and links to both awesome-copilot instructions and similar local instructions |
| 26 | + **AWAIT** user request to proceed with installation or updates of specific instructions. DO NOT INSTALL OR UPDATE UNLESS DIRECTED TO DO SO. |
| 27 | +12. **Download/Update Assets**: For requested instructions, automatically: |
| 28 | + - Download new instructions to `.github/instructions/` folder |
| 29 | + - Update outdated instructions by replacing with latest version from awesome-copilot |
| 30 | + - Do NOT adjust content of the files |
| 31 | + - Use `#fetch` tool to download assets, but may use `curl` using `#runInTerminal` tool to ensure all content is retrieved |
| 32 | + - Use `#todos` tool to track progress |
| 33 | + |
| 34 | +## Context Analysis Criteria |
| 35 | + |
| 36 | +🔍 **Repository Patterns**: |
| 37 | +- Programming languages used (.cs, .js, .py, .ts, etc.) |
| 38 | +- Framework indicators (ASP.NET, React, Azure, Next.js, etc.) |
| 39 | +- Project types (web apps, APIs, libraries, tools) |
| 40 | +- Development workflow requirements (testing, CI/CD, deployment) |
| 41 | + |
| 42 | +🗨️ **Chat History Context**: |
| 43 | +- Recent discussions and pain points |
| 44 | +- Technology-specific questions |
| 45 | +- Coding standards discussions |
| 46 | +- Development workflow requirements |
| 47 | + |
| 48 | +## Output Format |
| 49 | + |
| 50 | +Display analysis results in structured table comparing awesome-copilot instructions with existing repository instructions: |
| 51 | + |
| 52 | +| Awesome-Copilot Instruction | Description | Already Installed | Similar Local Instruction | Suggestion Rationale | |
| 53 | +|------------------------------|-------------|-------------------|---------------------------|---------------------| |
| 54 | +| [blazor.instructions.md](https://github.com/github/awesome-copilot/blob/main/instructions/blazor.instructions.md) | Blazor development guidelines | ✅ Yes | blazor.instructions.md | Already covered by existing Blazor instructions | |
| 55 | +| [reactjs.instructions.md](https://github.com/github/awesome-copilot/blob/main/instructions/reactjs.instructions.md) | ReactJS development standards | ❌ No | None | Would enhance React development with established patterns | |
| 56 | +| [java.instructions.md](https://github.com/github/awesome-copilot/blob/main/instructions/java.instructions.md) | Java development best practices | ⚠️ Outdated | java.instructions.md | applyTo pattern differs: remote uses `'**/*.java'` vs local `'*.java'` - Update recommended | |
| 57 | + |
| 58 | +## Local Instructions Discovery Process |
| 59 | + |
| 60 | +1. List all `*.instructions.md` files in the `instructions/` directory |
| 61 | +2. For each discovered file, read front matter to extract `description` and `applyTo` patterns |
| 62 | +3. Build comprehensive inventory of existing instructions with their applicable file patterns |
| 63 | +4. Use this inventory to avoid suggesting duplicates |
| 64 | + |
| 65 | +## Version Comparison Process |
| 66 | + |
| 67 | +1. For each local instruction file, construct the raw GitHub URL to fetch the remote version: |
| 68 | + - Pattern: `https://raw.githubusercontent.com/github/awesome-copilot/main/instructions/<filename>` |
| 69 | +2. Fetch the remote version using the `#fetch` tool |
| 70 | +3. Compare entire file content (including front matter and body) |
| 71 | +4. Identify specific differences: |
| 72 | + - **Front matter changes** (description, applyTo patterns) |
| 73 | + - **Content updates** (guidelines, examples, best practices) |
| 74 | +5. Document key differences for outdated instructions |
| 75 | +6. Calculate similarity to determine if update is needed |
| 76 | + |
| 77 | +## File Structure Requirements |
| 78 | + |
| 79 | +Based on GitHub documentation, copilot-instructions files should be: |
| 80 | +- **Repository-wide instructions**: `.github/copilot-instructions.md` (applies to entire repository) |
| 81 | +- **Path-specific instructions**: `.github/instructions/NAME.instructions.md` (applies to specific file patterns via `applyTo` frontmatter) |
| 82 | +- **Community instructions**: `instructions/NAME.instructions.md` (for sharing and distribution) |
| 83 | + |
| 84 | +## Front Matter Structure |
| 85 | + |
| 86 | +Instructions files in awesome-copilot use this front matter format: |
| 87 | +```markdown |
| 88 | +--- |
| 89 | +description: 'Brief description of what this instruction provides' |
| 90 | +applyTo: '**/*.js,**/*.ts' # Optional: glob patterns for file matching |
| 91 | +--- |
| 92 | +``` |
| 93 | + |
| 94 | +## Requirements |
| 95 | + |
| 96 | +- Use `githubRepo` tool to get content from awesome-copilot repository instructions folder |
| 97 | +- Scan local file system for existing instructions in `.github/instructions/` directory |
| 98 | +- Read YAML front matter from local instruction files to extract descriptions and `applyTo` patterns |
| 99 | +- Compare local instructions with remote versions to detect outdated instructions |
| 100 | +- Compare against existing instructions in this repository to avoid duplicates |
| 101 | +- Focus on gaps in current instruction library coverage |
| 102 | +- Validate that suggested instructions align with repository's purpose and standards |
| 103 | +- Provide clear rationale for each suggestion |
| 104 | +- Include links to both awesome-copilot instructions and similar local instructions |
| 105 | +- Clearly identify outdated instructions with specific differences noted |
| 106 | +- Consider technology stack compatibility and project-specific needs |
| 107 | +- Don't provide any additional information or context beyond the table and the analysis |
| 108 | + |
| 109 | +## Icons Reference |
| 110 | + |
| 111 | +- ✅ Already installed and up-to-date |
| 112 | +- ⚠️ Installed but outdated (update available) |
| 113 | +- ❌ Not installed in repo |
| 114 | + |
| 115 | +## Update Handling |
| 116 | + |
| 117 | +When outdated instructions are identified: |
| 118 | +1. Include them in the output table with ⚠️ status |
| 119 | +2. Document specific differences in the "Suggestion Rationale" column |
| 120 | +3. Provide recommendation to update with key changes noted |
| 121 | +4. When user requests update, replace entire local file with remote version |
| 122 | +5. Preserve file location in `.github/instructions/` directory |
0 commit comments