Get the FREE Ultimate OpenClaw Setup Guide →

suggest-awesome-github-copilot-instructions

Scanned
npx machina-cli add skill github/awesome-copilot/suggest-awesome-github-copilot-instructions --openclaw
Files (1)
SKILL.md
7.5 KB

Suggest Awesome GitHub Copilot Instructions

Analyze current repository context and suggest relevant copilot-instruction files from the GitHub awesome-copilot repository that are not already available in this repository.

Process

  1. Fetch Available Instructions: Extract instruction list and descriptions from awesome-copilot README.instructions.md. Must use #fetch tool.
  2. Scan Local Instructions: Discover existing instruction files in .github/instructions/ folder
  3. Extract Descriptions: Read front matter from local instruction files to get descriptions and applyTo patterns
  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>)
  5. Compare Versions: Compare local instruction content with remote versions to identify:
    • Instructions that are up-to-date (exact match)
    • Instructions that are outdated (content differs)
    • Key differences in outdated instructions (description, applyTo patterns, content)
  6. Analyze Context: Review chat history, repository files, and current project needs
  7. Compare Existing: Check against instructions already available in this repository
  8. Match Relevance: Compare available instructions against identified patterns and requirements
  9. Present Options: Display relevant instructions with descriptions, rationale, and availability status including outdated instructions
  10. Validate: Ensure suggested instructions would add value not already covered by existing instructions
  11. Output: Provide structured table with suggestions, descriptions, and links to both awesome-copilot instructions and similar local instructions AWAIT user request to proceed with installation or updates of specific instructions. DO NOT INSTALL OR UPDATE UNLESS DIRECTED TO DO SO.
  12. Download/Update Assets: For requested instructions, automatically:
    • Download new instructions to .github/instructions/ folder
    • Update outdated instructions by replacing with latest version from awesome-copilot
    • Do NOT adjust content of the files
    • Use #fetch tool to download assets, but may use curl using #runInTerminal tool to ensure all content is retrieved
    • Use #todos tool to track progress

Context Analysis Criteria

šŸ” Repository Patterns:

  • Programming languages used (.cs, .js, .py, .ts, etc.)
  • Framework indicators (ASP.NET, React, Azure, Next.js, etc.)
  • Project types (web apps, APIs, libraries, tools)
  • Development workflow requirements (testing, CI/CD, deployment)

šŸ—Øļø Chat History Context:

  • Recent discussions and pain points
  • Technology-specific questions
  • Coding standards discussions
  • Development workflow requirements

Output Format

Display analysis results in structured table comparing awesome-copilot instructions with existing repository instructions:

Awesome-Copilot InstructionDescriptionAlready InstalledSimilar Local InstructionSuggestion Rationale
blazor.instructions.mdBlazor development guidelinesāœ… Yesblazor.instructions.mdAlready covered by existing Blazor instructions
reactjs.instructions.mdReactJS development standardsāŒ NoNoneWould enhance React development with established patterns
java.instructions.mdJava development best practicesāš ļø Outdatedjava.instructions.mdapplyTo pattern differs: remote uses '**/*.java' vs local '*.java' - Update recommended

Local Instructions Discovery Process

  1. List all *.instructions.md files in the instructions/ directory
  2. For each discovered file, read front matter to extract description and applyTo patterns
  3. Build comprehensive inventory of existing instructions with their applicable file patterns
  4. Use this inventory to avoid suggesting duplicates

Version Comparison Process

  1. For each local instruction file, construct the raw GitHub URL to fetch the remote version:
    • Pattern: https://raw.githubusercontent.com/github/awesome-copilot/main/instructions/<filename>
  2. Fetch the remote version using the #fetch tool
  3. Compare entire file content (including front matter and body)
  4. Identify specific differences:
    • Front matter changes (description, applyTo patterns)
    • Content updates (guidelines, examples, best practices)
  5. Document key differences for outdated instructions
  6. Calculate similarity to determine if update is needed

File Structure Requirements

Based on GitHub documentation, copilot-instructions files should be:

  • Repository-wide instructions: .github/copilot-instructions.md (applies to entire repository)
  • Path-specific instructions: .github/instructions/NAME.instructions.md (applies to specific file patterns via applyTo frontmatter)
  • Community instructions: instructions/NAME.instructions.md (for sharing and distribution)

Front Matter Structure

Instructions files in awesome-copilot use this front matter format:

---
description: 'Brief description of what this instruction provides'
applyTo: '**/*.js,**/*.ts' # Optional: glob patterns for file matching
---

Requirements

  • Use githubRepo tool to get content from awesome-copilot repository instructions folder
  • Scan local file system for existing instructions in .github/instructions/ directory
  • Read YAML front matter from local instruction files to extract descriptions and applyTo patterns
  • Compare local instructions with remote versions to detect outdated instructions
  • Compare against existing instructions in this repository to avoid duplicates
  • Focus on gaps in current instruction library coverage
  • Validate that suggested instructions align with repository's purpose and standards
  • Provide clear rationale for each suggestion
  • Include links to both awesome-copilot instructions and similar local instructions
  • Clearly identify outdated instructions with specific differences noted
  • Consider technology stack compatibility and project-specific needs
  • Don't provide any additional information or context beyond the table and the analysis

Icons Reference

  • āœ… Already installed and up-to-date
  • āš ļø Installed but outdated (update available)
  • āŒ Not installed in repo

Update Handling

When outdated instructions are identified:

  1. Include them in the output table with āš ļø status
  2. Document specific differences in the "Suggestion Rationale" column
  3. Provide recommendation to update with key changes noted
  4. When user requests update, replace entire local file with remote version
  5. Preserve file location in .github/instructions/ directory

Source

git clone https://github.com/github/awesome-copilot/blob/main/plugins/awesome-copilot/skills/suggest-awesome-github-copilot-instructions/SKILL.mdView on GitHub

Overview

This skill analyzes your repo context and chat history to propose relevant Copilot instruction files from the awesome-copilot project. It avoids duplicates with local instructions and flags outdated items that may need updates, helping keep guidance current and unique.

How This Skill Works

It fetches the available instructions list from awesome-copilot, scans local instructions, reads front matter to capture descriptions and applyTo patterns, and then fetches remote versions to compare with local copies. It evaluates relevance against your project context and presents options with status (up-to-date, outdated, or new) and rationale, awaiting your explicit install or update request.

When to Use It

  • Starting a new project and setting up Copilot guidance from scratch
  • Auditing an existing repo to remove duplicates and outdated instructions
  • Working across a multi-repo or monorepo to harmonize instruction coverage
  • Integrating updated Copilot guidelines for a tech stack (e.g., React, Node, Python) that you're using
  • Preparing to install or update instructions only upon explicit user approval

Quick Start

  1. Step 1: Use #fetch to retrieve the remote instruction list from awesome-copilot and enumerate candidates, while scanning your local .github/instructions/
  2. Step 2: Read the front matter of local instructions to capture descriptions and applyTo patterns, and compare with remote versions
  3. Step 3: Present a ranked set of options with status (up-to-date, outdated, new); await your explicit approval to install or update

Best Practices

  • Confirm there are no duplicates before installing or updating
  • Validate applyTo patterns align with files in this repo
  • Use the #fetch tool to pull remote instructions for accurate comparison
  • Do not install or update without explicit user approval
  • Test in a feature branch and review changes against project needs

Example Use Cases

  • A React web app wants Copilot guidelines sourced from awesome-copilot
  • A Python project audits and deduplicates local instruction files
  • A monorepo harmonizes Node, Python, and Go instructions
  • An API service replaces an outdated Go instruction with an updated version
  • A legacy app prepares for instruction updates with an approval workflow

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers ↗