From 2f3264bfc6335bd61dd12ca595f6d46b4b234e3f Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Thu, 14 Aug 2025 12:09:33 +1000 Subject: [PATCH 1/2] Add missing `mode` field to all prompt files with 'agent' as default (#180) * Initial plan * Add mode: 'agent' to all 14 prompt files missing the field, fix BOM character Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> * Revert description field format changes while keeping mode field additions Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> --- prompts/ai-prompt-engineering-safety-review.prompt.md | 1 + prompts/architecture-blueprint-generator.prompt.md | 1 + prompts/code-exemplars-blueprint-generator.prompt.md | 1 + prompts/comment-code-generate-a-tutorial.prompt.md | 1 + prompts/copilot-instructions-blueprint-generator.prompt.md | 1 + prompts/csharp-tunit.prompt.md | 2 +- prompts/editorconfig.prompt.md | 1 + prompts/folder-structure-blueprint-generator.prompt.md | 1 + prompts/gen-specs-as-issues.prompt.md | 1 + prompts/generate-custom-instructions-from-codebase.prompt.md | 1 + prompts/git-flow-branch-creator.prompt.md | 1 + prompts/javascript-typescript-jest.prompt.md | 1 + prompts/project-workflow-analysis-blueprint-generator.prompt.md | 1 + prompts/readme-blueprint-generator.prompt.md | 1 + prompts/technology-stack-blueprint-generator.prompt.md | 1 + 15 files changed, 15 insertions(+), 1 deletion(-) diff --git a/prompts/ai-prompt-engineering-safety-review.prompt.md b/prompts/ai-prompt-engineering-safety-review.prompt.md index 18a6be5..645d4fb 100644 --- a/prompts/ai-prompt-engineering-safety-review.prompt.md +++ b/prompts/ai-prompt-engineering-safety-review.prompt.md @@ -1,5 +1,6 @@ --- description: "Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content." +mode: 'agent' --- # AI Prompt Engineering Safety Review & Improvement diff --git a/prompts/architecture-blueprint-generator.prompt.md b/prompts/architecture-blueprint-generator.prompt.md index 452fe87..a82f09c 100644 --- a/prompts/architecture-blueprint-generator.prompt.md +++ b/prompts/architecture-blueprint-generator.prompt.md @@ -1,5 +1,6 @@ --- description: 'Comprehensive project architecture blueprint generator that analyzes codebases to create detailed architectural documentation. Automatically detects technology stacks and architectural patterns, generates visual diagrams, documents implementation patterns, and provides extensible blueprints for maintaining architectural consistency and guiding new development.' +mode: 'agent' --- # Comprehensive Project Architecture Blueprint Generator diff --git a/prompts/code-exemplars-blueprint-generator.prompt.md b/prompts/code-exemplars-blueprint-generator.prompt.md index 460cf18..dfa044f 100644 --- a/prompts/code-exemplars-blueprint-generator.prompt.md +++ b/prompts/code-exemplars-blueprint-generator.prompt.md @@ -1,5 +1,6 @@ --- description: 'Technology-agnostic prompt generator that creates customizable AI prompts for scanning codebases and identifying high-quality code exemplars. Supports multiple programming languages (.NET, Java, JavaScript, TypeScript, React, Angular, Python) with configurable analysis depth, categorization methods, and documentation formats to establish coding standards and maintain consistency across development teams.' +mode: 'agent' --- # Code Exemplars Blueprint Generator diff --git a/prompts/comment-code-generate-a-tutorial.prompt.md b/prompts/comment-code-generate-a-tutorial.prompt.md index 0d949c2..70f3c71 100644 --- a/prompts/comment-code-generate-a-tutorial.prompt.md +++ b/prompts/comment-code-generate-a-tutorial.prompt.md @@ -1,5 +1,6 @@ --- description: 'Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.' +mode: 'agent' --- Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial. diff --git a/prompts/copilot-instructions-blueprint-generator.prompt.md b/prompts/copilot-instructions-blueprint-generator.prompt.md index e5fc8c3..cc91c42 100644 --- a/prompts/copilot-instructions-blueprint-generator.prompt.md +++ b/prompts/copilot-instructions-blueprint-generator.prompt.md @@ -1,5 +1,6 @@ --- description: 'Technology-agnostic blueprint generator for creating comprehensive copilot-instructions.md files that guide GitHub Copilot to produce code consistent with project standards, architecture patterns, and exact technology versions by analyzing existing codebase patterns and avoiding assumptions.' +mode: 'agent' --- # Copilot Instructions Blueprint Generator diff --git a/prompts/csharp-tunit.prompt.md b/prompts/csharp-tunit.prompt.md index 9d1190b..e3c6b74 100644 --- a/prompts/csharp-tunit.prompt.md +++ b/prompts/csharp-tunit.prompt.md @@ -1,4 +1,4 @@ ---- +--- mode: 'agent' tools: ['changes', 'codebase', 'editFiles', 'problems', 'search'] description: 'Get best practices for TUnit unit testing, including data-driven tests' diff --git a/prompts/editorconfig.prompt.md b/prompts/editorconfig.prompt.md index f548986..397f983 100644 --- a/prompts/editorconfig.prompt.md +++ b/prompts/editorconfig.prompt.md @@ -1,6 +1,7 @@ --- title: 'EditorConfig Expert' description: 'Generates a comprehensive and best-practice-oriented .editorconfig file based on project analysis and user preferences.' +mode: 'agent' --- ## 📜 MISSION diff --git a/prompts/folder-structure-blueprint-generator.prompt.md b/prompts/folder-structure-blueprint-generator.prompt.md index cd6b3e9..bb015f1 100644 --- a/prompts/folder-structure-blueprint-generator.prompt.md +++ b/prompts/folder-structure-blueprint-generator.prompt.md @@ -1,5 +1,6 @@ --- description: 'Comprehensive technology-agnostic prompt for analyzing and documenting project folder structures. Auto-detects project types (.NET, Java, React, Angular, Python, Node.js, Flutter), generates detailed blueprints with visualization options, naming conventions, file placement patterns, and extension templates for maintaining consistent code organization across diverse technology stacks.' +mode: 'agent' --- # Project Folder Structure Blueprint Generator diff --git a/prompts/gen-specs-as-issues.prompt.md b/prompts/gen-specs-as-issues.prompt.md index 772b42f..5a3018d 100644 --- a/prompts/gen-specs-as-issues.prompt.md +++ b/prompts/gen-specs-as-issues.prompt.md @@ -1,5 +1,6 @@ --- description: 'This workflow guides you through a systematic approach to identify missing features, prioritize them, and create detailed specifications for implementation.' +mode: 'agent' --- # Product Manager Assistant: Feature Identification and Specification diff --git a/prompts/generate-custom-instructions-from-codebase.prompt.md b/prompts/generate-custom-instructions-from-codebase.prompt.md index ddb40c7..99ef2e1 100644 --- a/prompts/generate-custom-instructions-from-codebase.prompt.md +++ b/prompts/generate-custom-instructions-from-codebase.prompt.md @@ -1,5 +1,6 @@ --- description: 'Migration and code evolution instructions generator for GitHub Copilot. Analyzes differences between two project versions (branches, commits, or releases) to create precise instructions allowing Copilot to maintain consistency during technology migrations, major refactoring, or framework version upgrades.' +mode: 'agent' --- # Migration and Code Evolution Instructions Generator diff --git a/prompts/git-flow-branch-creator.prompt.md b/prompts/git-flow-branch-creator.prompt.md index f0a67ec..d3da709 100644 --- a/prompts/git-flow-branch-creator.prompt.md +++ b/prompts/git-flow-branch-creator.prompt.md @@ -1,6 +1,7 @@ --- description: 'Intelligent Git Flow branch creator that analyzes git status/diff and creates appropriate branches following the nvie Git Flow branching model.' tools: ['run_in_terminal', 'get_terminal_output'] +mode: 'agent' --- ### Instructions diff --git a/prompts/javascript-typescript-jest.prompt.md b/prompts/javascript-typescript-jest.prompt.md index 5aa8ce1..af7d29e 100644 --- a/prompts/javascript-typescript-jest.prompt.md +++ b/prompts/javascript-typescript-jest.prompt.md @@ -1,5 +1,6 @@ --- description: 'Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns.' +mode: 'agent' --- ### Test Structure diff --git a/prompts/project-workflow-analysis-blueprint-generator.prompt.md b/prompts/project-workflow-analysis-blueprint-generator.prompt.md index 6f0f0ba..83768bc 100644 --- a/prompts/project-workflow-analysis-blueprint-generator.prompt.md +++ b/prompts/project-workflow-analysis-blueprint-generator.prompt.md @@ -2,6 +2,7 @@ description: 'Comprehensive technology-agnostic prompt generator for documenting end-to-end application workflows. Automatically detects project architecture patterns, technology stacks, and data flow patterns to generate detailed implementation blueprints covering entry points, service layers, data access, error handling, and testing approaches across multiple technologies including .NET, Java/Spring, React, and microservices architectures.' +mode: 'agent' --- # Project Workflow Documentation Generator diff --git a/prompts/readme-blueprint-generator.prompt.md b/prompts/readme-blueprint-generator.prompt.md index a702108..d127cc1 100644 --- a/prompts/readme-blueprint-generator.prompt.md +++ b/prompts/readme-blueprint-generator.prompt.md @@ -1,6 +1,7 @@ --- description: 'Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.' +mode: 'agent' --- # README Generator Prompt diff --git a/prompts/technology-stack-blueprint-generator.prompt.md b/prompts/technology-stack-blueprint-generator.prompt.md index 2038038..4160859 100644 --- a/prompts/technology-stack-blueprint-generator.prompt.md +++ b/prompts/technology-stack-blueprint-generator.prompt.md @@ -1,5 +1,6 @@ --- description: 'Comprehensive technology stack blueprint generator that analyzes codebases to create detailed architectural documentation. Automatically detects technology stacks, programming languages, and implementation patterns across multiple platforms (.NET, Java, JavaScript, React, Python). Generates configurable blueprints with version information, licensing details, usage patterns, coding conventions, and visual diagrams. Provides implementation-ready templates and maintains architectural consistency for guided development.' +mode: 'agent' --- # Comprehensive Technology Stack Blueprint Generator From 5bddac345738748430dbd88cf522fc281ff9c82b Mon Sep 17 00:00:00 2001 From: John Papa Date: Thu, 14 Aug 2025 12:18:29 -0400 Subject: [PATCH 2/2] Update README.md with detailed instructions for using custom instructions, reusable prompts, and custom chat modes (#188) Co-authored-by: Matt Soucoup --- README.md | 41 +++++++++++++++++++++++++++++++++++------ 1 file changed, 35 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4be5b72..679b109 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,18 @@ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) ## 📋 Custom Instructions -Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices: +Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices. + +### How to Use Custom Instructions + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the instruction you want to use +- Download the `*.instructions.md` file and manually add it to your project's instruction collection + +**To Use/Apply:** +- Copy these instructions to your `.github/copilot-instructions.md` file in your workspace +- Create task-specific `.github/.instructions.md` files in your workspace's `.github/instructions` folder +- Instructions automatically apply to Copilot behavior once installed in your workspace | Title | Description | Install | | ----- | ----------- | ------- | @@ -86,12 +97,21 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for | [Terraform Conventions](instructions/terraform.instructions.md) | Terraform Conventions and Guidelines | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fterraform.instructions.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fterraform.instructions.md) | | [VueJS 3 Development Instructions](instructions/vuejs3.instructions.md) | VueJS 3 development standards and best practices with Composition API and TypeScript | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fvuejs3.instructions.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fvuejs3.instructions.md) | -> 💡 **Usage**: Copy these instructions to your `.github/copilot-instructions.md` file or create task-specific `.github/.instructions.md` files in your workspace's `.github/instructions` folder. - ## 🎯 Reusable Prompts Ready-to-use prompt templates for specific development scenarios and tasks, defining prompt text with a specific mode, model, and available set of tools. +### How to Use Reusable Prompts + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the prompt you want to use +- Download the `*.prompt.md` file and manually add it to your prompt collection + +**To Run/Execute:** +- Use `/prompt-name` in VS Code chat after installation +- Run the `Chat: Run Prompt` command from the Command Palette +- Hit the run button while you have a prompt file open in VS Code + | Title | Description | Install | | ----- | ----------- | ------- | | [AI Prompt Engineering Safety Review & Improvement](prompts/ai-prompt-engineering-safety-review.prompt.md) | Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md) | @@ -169,12 +189,21 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [Update Standard OO Component Documentation](prompts/update-oo-component-documentation.prompt.md) | Update existing object-oriented component documentation following industry best practices and architectural documentation standards. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fupdate-oo-component-documentation.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fupdate-oo-component-documentation.prompt.md) | | [Update Specification](prompts/update-specification.prompt.md) | Update an existing specification file for the solution, optimized for Generative AI consumption based on new requirements or updates to any existing code. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fupdate-specification.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fupdate-specification.prompt.md) | -> 💡 **Usage**: Use `/prompt-name` in VS Code chat, run `Chat: Run Prompt` command, or hit the run button while you have a prompt open. - ## 🧩 Custom Chat Modes Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows. +### How to Use Custom Chat Modes + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the chat mode you want to use +- Download the `*.chatmode.md` file and manually install it in VS Code using the Command Palette + +**To Activate/Use:** +- Import the chat mode configuration into your VS Code settings +- Access the installed chat modes through the VS Code Chat interface +- Select the desired chat mode from the available options in VS Code Chat + | Title | Description | Install | | ----- | ----------- | ------- | | [4.1 Beast Mode (VS Code v1.102)](chatmodes/4.1-Beast.chatmode.md) | GPT 4.1 as a top-notch coding agent. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2F4.1-Beast.chatmode.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2F4.1-Beast.chatmode.md) | @@ -262,4 +291,4 @@ This project may contain trademarks or logos for projects, products, or services trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. -Any use of third-party trademarks or logos are subject to those third-party's policies. \ No newline at end of file +Any use of third-party trademarks or logos are subject to those third-party's policies.