Github Copilot Customizations

This repository contains a curated collection of custom resources designed to enhance and specialize the GitHub Copilot experience within Visual Studio Code. It provides a library of Agents (Chat Modes), Instructions, Prompts, and Collections that developers can adopt to tailor Copilot's behavior to specific technology stacks, architectural patterns, and project requirements.

Overview

GitHub Copilot allows for customization through specific file types. This repository serves as a centralized registry for these customizations, categorized by their function:

• Agents (*.agent.md): Specialized personas with specific context, tools, and behavioral rules.
• Instructions (*.instructions.md): Context-aware guidelines that modify how Copilot generates code for specific file types or languages.
• Prompts (*.prompt.md): Reusable, pre-defined prompts for complex or repetitive tasks.
• Collections: Groupings of the above resources tailored for specific domains (e.g., Azure Development, Java Spring Boot).

Repository Structure

The repository is organized into the following directories:

agents/

Contains Chat Mode definitions. These files define specialized personas for Copilot.

• Examples: 4.1-Beast.agent.md, azure-principal-architect.agent.md, gilfoyle.agent.md, rust-mcp-expert.agent.md.

instructions/

Contains rule sets that guide Copilot's code generation style and constraints. These are typically referenced by .github/copilot-instructions.md or applied to specific file paths.

• Examples: csharp.instructions.md, reactjs.instructions.md, security-and-owasp.instructions.md.

prompts/

Contains reusable prompt templates that automate specific workflows.

• Examples: create-unit-tests.prompt.md, refactor-code.prompt.md, generate-documentation.prompt.md.

collections/

Contains markdown files that group related agents, instructions, and prompts for specific development scenarios.

• Examples: azure-cloud-development.md, java-development.md, security-best-practices.md.

docs/

Generated documentation listing available resources.

• Files: README.agents.md, README.instructions.md, README.prompts.md, README.collections.md.

Getting Started

To use these resources in your own project, you can integrate them into your repository's .github directory.

using Instructions

1. Navigate to the instructions/ directory.
2. Select the instruction files relevant to your technology stack (e.g., typescript.instructions.md).
3. Copy the content or reference these files in your project's .github/copilot-instructions.md.

Using Agents and Prompts

1. Copy the desired *.agent.md or *.prompt.md files into your project's .github/copilot/ directory (or the directory configured for your VS Code workspace).
2. Reload VS Code to recognize the new capabilities.
3. Access Agents using @ in Copilot Chat (e.g., @azure-architect).
4. Access Prompts using / in Copilot Chat (e.g., /refactor).

Contribution Guidelines

We welcome contributions to expand the library of Copilot customizations. Please ensure your contributions adhere to the following standards found in .github/copilot-instructions.md:

General Rules

• Ensure all markdown files have valid YAML front matter.
• Include a clear description field wrapped in single quotes.
• Use lowercase filenames with words separated by hyphens.

Specific File Requirements

Prompts (.prompt.md)

• Must specify a mode (ask, edit, or agent).
• Should explicitly list required tools.

Instructions (.instructions.md)

• Must include an applyTo field specifying target file glob patterns (e.g., '**/*.ts').

Chat Modes (.agent.md)

• Should specify a model if the agent is optimized for a specific LLM version.
• Must list available tools.

License

Please refer to the repository license file for usage terms.