Merge branch 'feat/gpt-5-beast-mode-chatmode' of https://github.com/nicholasdbrady/awesome-copilot into pr/nicholasdbrady/306
This commit is contained in:
Aaron Powell
commit
cf0266c146
@ -41,6 +41,8 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
|||||||
| [Conventional Commit](instructions/conventional-commit.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) | Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation. |
|
| [Conventional Commit](instructions/conventional-commit.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) | Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation. |
|
||||||
| [Convert Spring JPA project to Spring Data Cosmos](instructions/convert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md) | Step-by-step guide for converting Spring Boot JPA applications to use Azure Cosmos DB with Spring Data Cosmos |
|
| [Convert Spring JPA project to Spring Data Cosmos](instructions/convert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md) | Step-by-step guide for converting Spring Boot JPA applications to use Azure Cosmos DB with Spring Data Cosmos |
|
||||||
| [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) | See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed |
|
| [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) | See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed |
|
||||||
|
| [Copilot Prompt Files Guidelines](instructions/prompt.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fprompt.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fprompt.instructions.md) | Guidelines for creating high-quality prompt files for GitHub Copilot |
|
||||||
|
| [Custom Instructions File Guidelines](instructions/instructions.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md) | Guidelines for creating high-quality custom instruction files for GitHub Copilot |
|
||||||
| [Dart and Flutter](instructions/dart-n-flutter.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md) | Instructions for writing Dart and Flutter code following the official recommendations. |
|
| [Dart and Flutter](instructions/dart-n-flutter.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md) | Instructions for writing Dart and Flutter code following the official recommendations. |
|
||||||
| [DDD Systems & .NET Guidelines](instructions/dotnet-architecture-good-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md) | DDD and .NET architecture guidelines |
|
| [DDD Systems & .NET Guidelines](instructions/dotnet-architecture-good-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md) | DDD and .NET architecture guidelines |
|
||||||
| [Dev Box image definitions](instructions/devbox-image-definition.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md) | Authoring recommendations for creating YAML based image definition files for use with Microsoft Dev Box Team Customizations |
|
| [Dev Box image definitions](instructions/devbox-image-definition.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md) | Authoring recommendations for creating YAML based image definition files for use with Microsoft Dev Box Team Customizations |
|
||||||
|
|||||||
@ -17,6 +17,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
|||||||
| [.NET/C# Best Practices](prompts/dotnet-best-practices.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-best-practices.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-best-practices.prompt.md) | Ensure .NET/C# code meets best practices for the solution/project. |
|
| [.NET/C# Best Practices](prompts/dotnet-best-practices.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-best-practices.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-best-practices.prompt.md) | Ensure .NET/C# code meets best practices for the solution/project. |
|
||||||
| [.NET/C# Design Pattern Review](prompts/dotnet-design-pattern-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md) | Review the C#/.NET code for design pattern implementation and suggest improvements. |
|
| [.NET/C# Design Pattern Review](prompts/dotnet-design-pattern-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md) | Review the C#/.NET code for design pattern implementation and suggest improvements. |
|
||||||
| [Act Informed: First understand together with the human, then do](prompts/first-ask.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md) | Interactive, input-tool powered, task refinement workflow: interrogates scope, deliverables, constraints before carrying out the task; Requires the Joyride extension. |
|
| [Act Informed: First understand together with the human, then do](prompts/first-ask.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md) | Interactive, input-tool powered, task refinement workflow: interrogates scope, deliverables, constraints before carrying out the task; Requires the Joyride extension. |
|
||||||
|
| [Add Educational Comments](prompts/add-educational-comments.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fadd-educational-comments.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fadd-educational-comments.prompt.md) | Add educational comments to the file specified, or prompt asking for file to comment if one is not provided. |
|
||||||
| [AI Prompt Engineering Safety Review & Improvement](prompts/ai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?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) | 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. |
|
| [AI Prompt Engineering Safety Review & Improvement](prompts/ai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?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) | 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. |
|
||||||
| [ASP.NET .NET Framework Containerization Prompt](prompts/containerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md) | Containerize an ASP.NET .NET Framework project by creating Dockerfile and .dockerfile files customized for the project. |
|
| [ASP.NET .NET Framework Containerization Prompt](prompts/containerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md) | Containerize an ASP.NET .NET Framework project by creating Dockerfile and .dockerfile files customized for the project. |
|
||||||
| [ASP.NET Core Docker Containerization Prompt](prompts/containerize-aspnetcore.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md) | Containerize an ASP.NET Core project by creating Dockerfile and .dockerfile files customized for the project. |
|
| [ASP.NET Core Docker Containerization Prompt](prompts/containerize-aspnetcore.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md) | Containerize an ASP.NET Core project by creating Dockerfile and .dockerfile files customized for the project. |
|
||||||
@ -54,6 +55,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
|||||||
| [Epic Product Requirements Document (PRD) Prompt](prompts/breakdown-epic-pm.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md) | Prompt for creating an Epic Product Requirements Document (PRD) for a new epic. This PRD will be used as input for generating a technical architecture specification. |
|
| [Epic Product Requirements Document (PRD) Prompt](prompts/breakdown-epic-pm.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md) | Prompt for creating an Epic Product Requirements Document (PRD) for a new epic. This PRD will be used as input for generating a technical architecture specification. |
|
||||||
| [Feature Implementation Plan Prompt](prompts/breakdown-feature-implementation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md) | Prompt for creating detailed feature implementation plans, following Epoch monorepo structure. |
|
| [Feature Implementation Plan Prompt](prompts/breakdown-feature-implementation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md) | Prompt for creating detailed feature implementation plans, following Epoch monorepo structure. |
|
||||||
| [Feature PRD Prompt](prompts/breakdown-feature-prd.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md) | Prompt for creating Product Requirements Documents (PRDs) for new features, based on an Epic. |
|
| [Feature PRD Prompt](prompts/breakdown-feature-prd.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md) | Prompt for creating Product Requirements Documents (PRDs) for new features, based on an Epic. |
|
||||||
|
| [Finalize Agent Prompt](prompts/finalize-agent-prompt.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffinalize-agent-prompt.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffinalize-agent-prompt.prompt.md) | Finalize prompt file using the role of an ai-agent to polish the prompt for the end user. |
|
||||||
| [Generate Standard OO Component Documentation](prompts/create-oo-component-documentation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-oo-component-documentation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-oo-component-documentation.prompt.md) | Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards. |
|
| [Generate Standard OO Component Documentation](prompts/create-oo-component-documentation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-oo-component-documentation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-oo-component-documentation.prompt.md) | Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards. |
|
||||||
| [Git Flow Branch Creator](prompts/git-flow-branch-creator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgit-flow-branch-creator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgit-flow-branch-creator.prompt.md) | Intelligent Git Flow branch creator that analyzes git status/diff and creates appropriate branches following the nvie Git Flow branching model. |
|
| [Git Flow Branch Creator](prompts/git-flow-branch-creator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgit-flow-branch-creator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgit-flow-branch-creator.prompt.md) | Intelligent Git Flow branch creator that analyzes git status/diff and creates appropriate branches following the nvie Git Flow branching model. |
|
||||||
| [Github Copilot Starter](prompts/github-copilot-starter.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgithub-copilot-starter.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgithub-copilot-starter.prompt.md) | Set up complete GitHub Copilot configuration for a new project based on technology stack |
|
| [Github Copilot Starter](prompts/github-copilot-starter.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgithub-copilot-starter.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgithub-copilot-starter.prompt.md) | Set up complete GitHub Copilot configuration for a new project based on technology stack |
|
||||||
@ -86,6 +88,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
|||||||
| [Refactoring Java Methods with Extract Method](prompts/java-refactoring-extract-method.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md) | Refactoring using Extract Methods in Java Language |
|
| [Refactoring Java Methods with Extract Method](prompts/java-refactoring-extract-method.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md) | Refactoring using Extract Methods in Java Language |
|
||||||
| [Repo Story Time](prompts/repo-story-time.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md) | Generate a comprehensive repository summary and narrative story from commit history |
|
| [Repo Story Time](prompts/repo-story-time.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md) | Generate a comprehensive repository summary and narrative story from commit history |
|
||||||
| [Review And Refactor](prompts/review-and-refactor.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md) | Review and refactor code in your project according to defined instructions |
|
| [Review And Refactor](prompts/review-and-refactor.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md) | Review and refactor code in your project according to defined instructions |
|
||||||
|
| [Shuffle JSON Data](prompts/shuffle-json-data.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fshuffle-json-data.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fshuffle-json-data.prompt.md) | Shuffle repetitive JSON objects safely by validating schema consistency before randomising entries. |
|
||||||
| [Spring Boot Best Practices](prompts/java-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md) | Get best practices for developing applications with Spring Boot. |
|
| [Spring Boot Best Practices](prompts/java-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md) | Get best practices for developing applications with Spring Boot. |
|
||||||
| [Spring Boot with Kotlin Best Practices](prompts/kotlin-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md) | Get best practices for developing applications with Spring Boot and Kotlin. |
|
| [Spring Boot with Kotlin Best Practices](prompts/kotlin-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md) | Get best practices for developing applications with Spring Boot and Kotlin. |
|
||||||
| [SQL Code Review](prompts/sql-code-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md) | Universal SQL code review assistant that performs comprehensive security, maintainability, and code quality analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Focuses on SQL injection prevention, access control, code standards, and anti-pattern detection. Complements SQL optimization prompt for complete development coverage. |
|
| [SQL Code Review](prompts/sql-code-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md) | Universal SQL code review assistant that performs comprehensive security, maintainability, and code quality analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Focuses on SQL injection prevention, access control, code standards, and anti-pattern detection. Complements SQL optimization prompt for complete development coverage. |
|
||||||
|
|||||||
256
instructions/instructions.instructions.md
Normal file
256
instructions/instructions.instructions.md
Normal file
@ -0,0 +1,256 @@
|
|||||||
|
---
|
||||||
|
description: 'Guidelines for creating high-quality custom instruction files for GitHub Copilot'
|
||||||
|
applyTo: '**/*.instructions.md'
|
||||||
|
---
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
- **description**: Single-quoted string, 1-500 characters, clearly stating the purpose
|
||||||
|
- **applyTo**: Glob pattern(s) specifying which files these instructions apply to
|
||||||
|
- Single pattern: `'**/*.ts'`
|
||||||
|
- Multiple patterns: `'**/*.ts, **/*.tsx, **/*.js'`
|
||||||
|
- Specific files: `'src/**/*.py'`
|
||||||
|
- All files: `'**'`
|
||||||
|
|
||||||
|
## File Structure
|
||||||
|
|
||||||
|
A well-structured instruction file should include the following sections:
|
||||||
|
|
||||||
|
### 1. Title and Overview
|
||||||
|
|
||||||
|
- Clear, descriptive title using `#` heading
|
||||||
|
- Brief introduction explaining the purpose and scope
|
||||||
|
- Optional: Project context section with key technologies and versions
|
||||||
|
|
||||||
|
### 2. Core Sections
|
||||||
|
|
||||||
|
Organize content into logical sections based on the domain:
|
||||||
|
|
||||||
|
- **General Instructions**: High-level guidelines and principles
|
||||||
|
- **Best Practices**: Recommended patterns and approaches
|
||||||
|
- **Code Standards**: Naming conventions, formatting, style rules
|
||||||
|
- **Architecture/Structure**: Project organization and design patterns
|
||||||
|
- **Common Patterns**: Frequently used implementations
|
||||||
|
- **Security**: Security considerations (if applicable)
|
||||||
|
- **Performance**: Optimization guidelines (if applicable)
|
||||||
|
- **Testing**: Testing standards and approaches (if applicable)
|
||||||
|
|
||||||
|
### 3. Examples and Code Snippets
|
||||||
|
|
||||||
|
Provide concrete examples with clear labels:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
### Good Example
|
||||||
|
\`\`\`language
|
||||||
|
// Recommended approach
|
||||||
|
code example here
|
||||||
|
\`\`\`
|
||||||
|
|
||||||
|
### Bad Example
|
||||||
|
\`\`\`language
|
||||||
|
// Avoid this pattern
|
||||||
|
code example here
|
||||||
|
\`\`\`
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Validation and Verification (Optional but Recommended)
|
||||||
|
|
||||||
|
- Build commands to verify code
|
||||||
|
- Linting and formatting tools
|
||||||
|
- Testing requirements
|
||||||
|
- Verification steps
|
||||||
|
|
||||||
|
## Content Guidelines
|
||||||
|
|
||||||
|
### Writing Style
|
||||||
|
|
||||||
|
- Use clear, concise language
|
||||||
|
- Write in imperative mood ("Use", "Implement", "Avoid")
|
||||||
|
- Be specific and actionable
|
||||||
|
- Avoid ambiguous terms like "should", "might", "possibly"
|
||||||
|
- Use bullet points and lists for readability
|
||||||
|
- Keep sections focused and scannable
|
||||||
|
|
||||||
|
### Best Practices
|
||||||
|
|
||||||
|
- **Be Specific**: Provide concrete examples rather than abstract concepts
|
||||||
|
- **Show Why**: Explain the reasoning behind recommendations when it adds value
|
||||||
|
- **Use Tables**: For comparing options, listing rules, or showing patterns
|
||||||
|
- **Include Examples**: Real code snippets are more effective than descriptions
|
||||||
|
- **Stay Current**: Reference current versions and best practices
|
||||||
|
- **Link Resources**: Include official documentation and authoritative sources
|
||||||
|
|
||||||
|
### Common Patterns to Include
|
||||||
|
|
||||||
|
1. **Naming Conventions**: How to name variables, functions, classes, files
|
||||||
|
2. **Code Organization**: File structure, module organization, import order
|
||||||
|
3. **Error Handling**: Preferred error handling patterns
|
||||||
|
4. **Dependencies**: How to manage and document dependencies
|
||||||
|
5. **Comments and Documentation**: When and how to document code
|
||||||
|
6. **Version Information**: Target language/framework versions
|
||||||
|
|
||||||
|
## Patterns to Follow
|
||||||
|
|
||||||
|
### Bullet Points and Lists
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Security Best Practices
|
||||||
|
|
||||||
|
- Always validate user input before processing
|
||||||
|
- Use parameterized queries to prevent SQL injection
|
||||||
|
- Store secrets in environment variables, never in code
|
||||||
|
- Implement proper authentication and authorization
|
||||||
|
- Enable HTTPS for all production endpoints
|
||||||
|
```
|
||||||
|
|
||||||
|
### Tables for Structured Information
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Common Issues
|
||||||
|
|
||||||
|
| Issue | Solution | Example |
|
||||||
|
| ---------------- | ------------------- | ----------------------------- |
|
||||||
|
| Magic numbers | Use named constants | `const MAX_RETRIES = 3` |
|
||||||
|
| Deep nesting | Extract functions | Refactor nested if statements |
|
||||||
|
| Hardcoded values | Use configuration | Store API URLs in config |
|
||||||
|
```
|
||||||
|
|
||||||
|
### Code Comparison
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
### Good Example - Using TypeScript interfaces
|
||||||
|
\`\`\`typescript
|
||||||
|
interface User {
|
||||||
|
id: string;
|
||||||
|
name: string;
|
||||||
|
email: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getUser(id: string): User {
|
||||||
|
// Implementation
|
||||||
|
}
|
||||||
|
\`\`\`
|
||||||
|
|
||||||
|
### Bad Example - Using any type
|
||||||
|
\`\`\`typescript
|
||||||
|
function getUser(id: any): any {
|
||||||
|
// Loses type safety
|
||||||
|
}
|
||||||
|
\`\`\`
|
||||||
|
```
|
||||||
|
|
||||||
|
### Conditional Guidance
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Framework Selection
|
||||||
|
|
||||||
|
- **For small projects**: Use Minimal API approach
|
||||||
|
- **For large projects**: Use controller-based architecture with clear separation
|
||||||
|
- **For microservices**: Consider domain-driven design patterns
|
||||||
|
```
|
||||||
|
|
||||||
|
## Patterns to Avoid
|
||||||
|
|
||||||
|
- **Overly verbose explanations**: Keep it concise and scannable
|
||||||
|
- **Outdated information**: Always reference current versions and practices
|
||||||
|
- **Ambiguous guidelines**: Be specific about what to do or avoid
|
||||||
|
- **Missing examples**: Abstract rules without concrete code examples
|
||||||
|
- **Contradictory advice**: Ensure consistency throughout the file
|
||||||
|
- **Copy-paste from documentation**: Add value by distilling and contextualizing
|
||||||
|
|
||||||
|
## Testing Your Instructions
|
||||||
|
|
||||||
|
Before finalizing instruction files:
|
||||||
|
|
||||||
|
1. **Test with Copilot**: Try the instructions with actual prompts in VS Code
|
||||||
|
2. **Verify Examples**: Ensure code examples are correct and run without errors
|
||||||
|
3. **Check Glob Patterns**: Confirm `applyTo` patterns match intended files
|
||||||
|
|
||||||
|
## Example Structure
|
||||||
|
|
||||||
|
Here's a minimal example structure for a new instruction file:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
---
|
||||||
|
description: 'Brief description of purpose'
|
||||||
|
applyTo: '**/*.ext'
|
||||||
|
---
|
||||||
|
|
||||||
|
# Technology Name Development
|
||||||
|
|
||||||
|
Brief introduction and context.
|
||||||
|
|
||||||
|
## General Instructions
|
||||||
|
|
||||||
|
- High-level guideline 1
|
||||||
|
- High-level guideline 2
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
- Specific practice 1
|
||||||
|
- Specific practice 2
|
||||||
|
|
||||||
|
## Code Standards
|
||||||
|
|
||||||
|
### Naming Conventions
|
||||||
|
- Rule 1
|
||||||
|
- Rule 2
|
||||||
|
|
||||||
|
### File Organization
|
||||||
|
- Structure 1
|
||||||
|
- Structure 2
|
||||||
|
|
||||||
|
## Common Patterns
|
||||||
|
|
||||||
|
### Pattern 1
|
||||||
|
Description and example
|
||||||
|
|
||||||
|
\`\`\`language
|
||||||
|
code example
|
||||||
|
\`\`\`
|
||||||
|
|
||||||
|
### Pattern 2
|
||||||
|
Description and example
|
||||||
|
|
||||||
|
## Validation
|
||||||
|
|
||||||
|
- Build command: `command to verify`
|
||||||
|
- Linting: `command to lint`
|
||||||
|
- Testing: `command to test`
|
||||||
|
```
|
||||||
|
|
||||||
|
## Maintenance
|
||||||
|
|
||||||
|
- Review instructions when dependencies or frameworks are updated
|
||||||
|
- Update examples to reflect current best practices
|
||||||
|
- Remove outdated patterns or deprecated features
|
||||||
|
- Add new patterns as they emerge in the community
|
||||||
|
- Keep glob patterns accurate as project structure evolves
|
||||||
|
|
||||||
|
## Additional Resources
|
||||||
|
|
||||||
|
- [Custom Instructions Documentation](https://code.visualstudio.com/docs/copilot/customization/custom-instructions)
|
||||||
|
- [Awesome Copilot Instructions](https://github.com/github/awesome-copilot/tree/main/instructions)
|
||||||
@ -9,12 +9,14 @@ You are an expert Clojure interactive programmer specializing in Joyride - VS Co
|
|||||||
|
|
||||||
## Essential Information Sources
|
## Essential Information Sources
|
||||||
|
|
||||||
**Always use these tools first** to get comprehensive, up-to-date information:
|
For comprehensive, up-to-date Joyride information, use the `fetch_webpage` tool to access these guides:
|
||||||
|
|
||||||
- **Joyride agent guide** - Technical guide for LLM agents using Joyride evaluation capabilities
|
- **Joyride agent guide**: https://raw.githubusercontent.com/BetterThanTomorrow/joyride/master/assets/llm-contexts/agent-joyride-eval.md
|
||||||
- **Joyride user guide** - Complete user assistance guide with project structure, patterns, examples, and troubleshooting
|
- Technical guide for LLM agents using Joyride evaluation capabilities
|
||||||
|
- **Joyride user guide**: https://raw.githubusercontent.com/BetterThanTomorrow/joyride/master/assets/llm-contexts/user-assistance.md
|
||||||
|
- Complete user assistance guide with project structure, patterns, examples, and troubleshooting
|
||||||
|
|
||||||
These tools contain all the detailed information about Joyride APIs, project structure, common patterns, user workflows, and troubleshooting guidance.
|
These guides contain all the detailed information about Joyride APIs, project structure, common patterns, user workflows, and troubleshooting guidance.
|
||||||
|
|
||||||
## Core Philosophy: Interactive Programming (aka REPL-Driven Development)
|
## Core Philosophy: Interactive Programming (aka REPL-Driven Development)
|
||||||
|
|
||||||
@ -145,40 +147,43 @@ The evaluation tool has an `awaitResult` parameter for handling async operations
|
|||||||
{:available false :reason "Extension not installed"}))
|
{:available false :reason "Extension not installed"}))
|
||||||
```
|
```
|
||||||
|
|
||||||
### Joyride Flares - WebView Creation
|
## Joyride Flares - WebView Creation
|
||||||
Joyride Flares provide a powerful way to create visual interfaces and display rich content in VS Code:
|
|
||||||
|
|
||||||
|
Joyride Flares provide a convenient way to create WebView panels and sidebar views.
|
||||||
|
|
||||||
|
### Basic Usage
|
||||||
```clojure
|
```clojure
|
||||||
(require '[joyride.flare :as flare])
|
(require '[joyride.flare :as flare])
|
||||||
|
|
||||||
;; Simple HTML flare
|
;; Create a flare with Hiccup
|
||||||
(flare/flare! {:html [:h1 "Hello World!"]
|
(flare/flare!+ {:html [:h1 "Hello World!"]
|
||||||
:title "My Flare"
|
:title "My Flare"
|
||||||
:key "greeting"})
|
:key "example"})
|
||||||
|
|
||||||
;; Flare with external URL
|
;; Create sidebar flare (slots 1-5 available)
|
||||||
(flare/flare! {:url "https://example.com"
|
(flare/flare!+ {:html [:div [:h2 "Sidebar"] [:p "Content"]]
|
||||||
:title "External Site"})
|
:key :sidebar-1})
|
||||||
|
|
||||||
;; Sidebar flare
|
;; Load from file (HTML or EDN with Hiccup)
|
||||||
(flare/flare! {:html [:div [:h2 "Sidebar"] [:p "Content"]]
|
(flare/flare!+ {:file "assets/my-view.html"
|
||||||
:sidebar-panel? true})
|
:key "my-view"})
|
||||||
|
|
||||||
;; Data visualization
|
;; Display external URL
|
||||||
(flare/flare! {:html [:svg {:width 200 :height 200}
|
(flare/flare!+ {:url "https://example.com"
|
||||||
[:circle {:cx 100 :cy 100 :r 50 :fill :blue}]]
|
:title "External Site"})
|
||||||
:title "SVG Demo"})
|
|
||||||
|
|
||||||
;; Manage flares
|
|
||||||
(flare/ls) ; List all active flares
|
|
||||||
(flare/close! "greeting") ; Close specific flare by key
|
|
||||||
(flare/close-all!) ; Close all flares
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Flare Style Guidelines:**
|
**Note**: `flare!+` returns a promise, use `awaitResult: true`.
|
||||||
- Use maps for `:style` attributes: `{:style {:color :red :border "1px solid #ccc"}}`
|
|
||||||
- Prefer keywords for simple CSS values: `:color :red`
|
### Key Points
|
||||||
- Use strings for compound CSS property values: `:border "1px solid #ccc"`
|
- **Hiccup styles**: Use maps for `:style` attributes: `{:color :red :margin "10px"}`
|
||||||
|
- **File paths**: Absolute, relative (requires workspace), or Uri objects
|
||||||
|
- **Management**: `(flare/close! key)`, `(flare/ls)`, `(flare/close-all!)`
|
||||||
|
- **Bidirectional messaging**: Use `:message-handler` and `post-message!+`
|
||||||
|
|
||||||
|
**Full documentation**: [API docs](https://github.com/BetterThanTomorrow/joyride/blob/master/doc/api.md#joyrideflare)
|
||||||
|
|
||||||
|
**Comprehensive examples**: [flares_examples.cljs](https://github.com/BetterThanTomorrow/joyride/blob/master/examples/.joyride/src/flares_examples.cljs)
|
||||||
|
|
||||||
## Common User Patterns
|
## Common User Patterns
|
||||||
|
|
||||||
|
|||||||
@ -1,21 +1,12 @@
|
|||||||
---
|
---
|
||||||
description: 'Expert assistance for Joyride Workspace automation - REPL-driven and user space ClojureScript automation within specific VS Code workspaces'
|
description: 'Expert assistance for Joyride Workspace automation - REPL-driven and user space ClojureScript automation within specific VS Code workspaces'
|
||||||
applyTo: '.joyride/**/*.*'
|
applyTo: "**/.joyride/**"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Joyride Workspace Automation Assistant
|
# Joyride Workspace Automation Assistant
|
||||||
|
|
||||||
You are an expert Clojure interactive programmer specializing in Joyride workspace automation - project-specific VS Code customization using ClojureScript. Joyride runs SCI ClojureScript in VS Code's Extension Host with full access to the VS Code API and workspace context. Your main tool is `joyride_evaluate_code` with which you test and validate code directly in VS Code's runtime environment. The REPL is your superpower - use it to provide tested, working solutions rather than theoretical suggestions.
|
You are an expert Clojure interactive programmer specializing in Joyride workspace automation - project-specific VS Code customization using ClojureScript. Joyride runs SCI ClojureScript in VS Code's Extension Host with full access to the VS Code API and workspace context. Your main tool is `joyride_evaluate_code` with which you test and validate code directly in VS Code's runtime environment. The REPL is your superpower - use it to provide tested, working solutions rather than theoretical suggestions.
|
||||||
|
|
||||||
## Essential Information Sources
|
|
||||||
|
|
||||||
**Always use these tools first** to get comprehensive, up-to-date information:
|
|
||||||
|
|
||||||
- `joyride_basics_for_agents` - Technical guide for LLM agents using Joyride evaluation capabilities
|
|
||||||
- `joyride_assisting_users_guide` - Complete user assistance guide with project structure, patterns, examples, and troubleshooting
|
|
||||||
|
|
||||||
These tools contain all the detailed information about Joyride APIs, project structure, common patterns, user workflows, and troubleshooting guidance.
|
|
||||||
|
|
||||||
## Workspace Context Focus
|
## Workspace Context Focus
|
||||||
|
|
||||||
You specialize in **workspace-specific automation** - scripts and customizations that are:
|
You specialize in **workspace-specific automation** - scripts and customizations that are:
|
||||||
|
|||||||
73
instructions/prompt.instructions.md
Normal file
73
instructions/prompt.instructions.md
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
---
|
||||||
|
description: 'Guidelines for creating high-quality prompt files for GitHub Copilot'
|
||||||
|
applyTo: '**/*.prompt.md'
|
||||||
|
---
|
||||||
|
|
||||||
|
# Copilot Prompt Files Guidelines
|
||||||
|
|
||||||
|
Instructions for creating effective and maintainable prompt files that guide GitHub Copilot in delivering consistent, high-quality outcomes across any repository.
|
||||||
|
|
||||||
|
## Scope and Principles
|
||||||
|
- Target audience: maintainers and contributors authoring reusable prompts for Copilot Chat.
|
||||||
|
- Goals: predictable behaviour, clear expectations, minimal permissions, and portability across repositories.
|
||||||
|
- Primary references: VS Code documentation on prompt files and organization-specific conventions.
|
||||||
|
|
||||||
|
## Frontmatter Requirements
|
||||||
|
- Include `description` (single sentence, actionable outcome), `mode` (explicitly choose `ask`, `edit`, or `agent`), and `tools` (minimal set of tool bundles required to fulfill the prompt).
|
||||||
|
- Declare `model` when the prompt depends on a specific capability tier; otherwise inherit the active model.
|
||||||
|
- Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization.
|
||||||
|
- Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity.
|
||||||
|
|
||||||
|
## File Naming and Placement
|
||||||
|
- Use kebab-case filenames ending with `.prompt.md` and store them under `.github/prompts/` unless your workspace standard specifies another directory.
|
||||||
|
- Provide a short filename that communicates the action (for example, `generate-readme.prompt.md` rather than `prompt1.prompt.md`).
|
||||||
|
|
||||||
|
## Body Structure
|
||||||
|
- Start with an `#` level heading that matches the prompt intent so it surfaces well in Quick Pick search.
|
||||||
|
- Organize content with predictable sections. Recommended baseline: `Mission` or `Primary Directive`, `Scope & Preconditions`, `Inputs`, `Workflow` (step-by-step), `Output Expectations`, and `Quality Assurance`.
|
||||||
|
- Adjust section names to fit the domain, but retain the logical flow: why → context → inputs → actions → outputs → validation.
|
||||||
|
- Reference related prompts or instruction files using relative links to aid discoverability.
|
||||||
|
|
||||||
|
## Input and Context Handling
|
||||||
|
- Use `${input:variableName[:placeholder]}` for required values and explain when the user must supply them. Provide defaults or alternatives where possible.
|
||||||
|
- Call out contextual variables such as `${selection}`, `${file}`, `${workspaceFolder}` only when they are essential, and describe how Copilot should interpret them.
|
||||||
|
- Document how to proceed when mandatory context is missing (for example, “Request the file path and stop if it remains undefined”).
|
||||||
|
|
||||||
|
## Tool and Permission Guidance
|
||||||
|
- Limit `tools` to the smallest set that enables the task. List them in the preferred execution order when the sequence matters.
|
||||||
|
- If the prompt inherits tools from a chat mode, mention that relationship and state any critical tool behaviours or side effects.
|
||||||
|
- Warn about destructive operations (file creation, edits, terminal commands) and include guard rails or confirmation steps in the workflow.
|
||||||
|
|
||||||
|
## Instruction Tone and Style
|
||||||
|
- Write in direct, imperative sentences targeted at Copilot (for example, “Analyze”, “Generate”, “Summarize”).
|
||||||
|
- Keep sentences short and unambiguous, following Google Developer Documentation translation best practices to support localization.
|
||||||
|
- Avoid idioms, humor, or culturally specific references; favor neutral, inclusive language.
|
||||||
|
|
||||||
|
## Output Definition
|
||||||
|
- Specify the format, structure, and location of expected results (for example, “Create `docs/adr/adr-XXXX.md` using the template below”).
|
||||||
|
- Include success criteria and failure triggers so Copilot knows when to halt or retry.
|
||||||
|
- Provide validation steps—manual checks, automated commands, or acceptance criteria lists—that reviewers can execute after running the prompt.
|
||||||
|
|
||||||
|
## Examples and Reusable Assets
|
||||||
|
- Embed Good/Bad examples or scaffolds (Markdown templates, JSON stubs) that the prompt should produce or follow.
|
||||||
|
- Maintain reference tables (capabilities, status codes, role descriptions) inline to keep the prompt self-contained. Update these tables when upstream resources change.
|
||||||
|
- Link to authoritative documentation instead of duplicating lengthy guidance.
|
||||||
|
|
||||||
|
## Quality Assurance Checklist
|
||||||
|
- [ ] Frontmatter fields are complete, accurate, and least-privilege.
|
||||||
|
- [ ] Inputs include placeholders, default behaviours, and fallbacks.
|
||||||
|
- [ ] Workflow covers preparation, execution, and post-processing without gaps.
|
||||||
|
- [ ] Output expectations include formatting and storage details.
|
||||||
|
- [ ] Validation steps are actionable (commands, diff checks, review prompts).
|
||||||
|
- [ ] Security, compliance, and privacy policies referenced by the prompt are current.
|
||||||
|
- [ ] Prompt executes successfully in VS Code (`Chat: Run Prompt`) using representative scenarios.
|
||||||
|
|
||||||
|
## Maintenance Guidance
|
||||||
|
- Version-control prompts alongside the code they affect; update them when dependencies, tooling, or review processes change.
|
||||||
|
- Review prompts periodically to ensure tool lists, model requirements, and linked documents remain valid.
|
||||||
|
- Coordinate with other repositories: when a prompt proves broadly useful, extract common guidance into instruction files or shared prompt packs.
|
||||||
|
|
||||||
|
## Additional Resources
|
||||||
|
- [Prompt Files Documentation](https://code.visualstudio.com/docs/copilot/customization/prompt-files#_prompt-file-format)
|
||||||
|
- [Awesome Copilot Prompt Files](https://github.com/github/awesome-copilot/tree/main/prompts)
|
||||||
|
- [Tool Configuration](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode#_agent-mode-tools)
|
||||||
@ -53,6 +53,6 @@ applyTo: '**/*.java, **/*.kt'
|
|||||||
## Build and Verification
|
## Build and Verification
|
||||||
|
|
||||||
- After adding or modifying code, verify the project continues to build successfully.
|
- After adding or modifying code, verify the project continues to build successfully.
|
||||||
- If the project uses Maven, run `mvn clean install`.
|
- If the project uses Maven, run `mvn clean package`.
|
||||||
- If the project uses Gradle, run `./gradlew build` (or `gradlew.bat build` on Windows).
|
- If the project uses Gradle, run `./gradlew build` (or `gradlew.bat build` on Windows).
|
||||||
- Ensure all tests pass as part of the build.
|
- Ensure all tests pass as part of the build.
|
||||||
|
|||||||
129
prompts/add-educational-comments.prompt.md
Normal file
129
prompts/add-educational-comments.prompt.md
Normal file
@ -0,0 +1,129 @@
|
|||||||
|
---
|
||||||
|
mode: 'agent'
|
||||||
|
description: 'Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.'
|
||||||
|
tools: ['edit/editFiles', 'fetch', 'todos']
|
||||||
|
---
|
||||||
|
|
||||||
|
# Add Educational Comments
|
||||||
|
|
||||||
|
Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.
|
||||||
|
|
||||||
|
## Role
|
||||||
|
|
||||||
|
You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.
|
||||||
|
|
||||||
|
- Provide foundational explanations for beginners
|
||||||
|
- Add practical insights and best practices for intermediate users
|
||||||
|
- Offer deeper context (performance, architecture, language internals) for advanced users
|
||||||
|
- Suggest improvements only when they meaningfully support understanding
|
||||||
|
- Always obey the **Educational Commenting Rules**
|
||||||
|
|
||||||
|
## Objectives
|
||||||
|
|
||||||
|
1. Transform the provided file by adding educational comments aligned with the configuration.
|
||||||
|
2. Maintain the file's structure, encoding, and build correctness.
|
||||||
|
3. Increase the total line count by **125%** using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.
|
||||||
|
|
||||||
|
### Line Count Guidance
|
||||||
|
|
||||||
|
- Default: add lines so the file reaches 125% of its original length.
|
||||||
|
- Hard limit: never add more than 400 educational comment lines.
|
||||||
|
- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
|
||||||
|
- Previously processed files: revise and improve current comments; do not chase the 125% increase again.
|
||||||
|
|
||||||
|
## Educational Commenting Rules
|
||||||
|
|
||||||
|
### Encoding and Formatting
|
||||||
|
|
||||||
|
- Determine the file's encoding before editing and keep it unchanged.
|
||||||
|
- Use only characters available on a standard QWERTY keyboard.
|
||||||
|
- Do not insert emojis or other special symbols.
|
||||||
|
- Preserve the original end-of-line style (LF or CRLF).
|
||||||
|
- Keep single-line comments on a single line.
|
||||||
|
- Maintain the indentation style required by the language (Python, Haskell, F#, Nim, Cobra, YAML, Makefiles, etc.).
|
||||||
|
- When instructed with `Line Number Referencing = yes`, prefix each new comment with `Note <number>` (e.g., `Note 1`).
|
||||||
|
|
||||||
|
### Content Expectations
|
||||||
|
|
||||||
|
- Focus on lines and blocks that best illustrate language or platform concepts.
|
||||||
|
- Explain the "why" behind syntax, idioms, and design choices.
|
||||||
|
- Reinforce previous concepts only when it improves comprehension (`Repetitiveness`).
|
||||||
|
- Highlight potential improvements gently and only when they serve an educational purpose.
|
||||||
|
- If `Line Number Referencing = yes`, use note numbers to connect related explanations.
|
||||||
|
|
||||||
|
### Safety and Compliance
|
||||||
|
|
||||||
|
- Do not alter namespaces, imports, module declarations, or encoding headers in a way that breaks execution.
|
||||||
|
- Avoid introducing syntax errors (for example, Python encoding errors per [PEP 263](https://peps.python.org/pep-0263/)).
|
||||||
|
- Input data as if typed on the user's keyboard.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
1. **Confirm Inputs** – Ensure at least one target file is provided. If missing, respond with: `Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.`
|
||||||
|
2. **Identify File(s)** – If multiple matches exist, present an ordered list so the user can choose by number or name.
|
||||||
|
3. **Review Configuration** – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g., `Line Numer`) using context.
|
||||||
|
4. **Plan Comments** – Decide which sections of the code best support the configured learning goals.
|
||||||
|
5. **Add Comments** – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax.
|
||||||
|
6. **Validate** – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied.
|
||||||
|
|
||||||
|
## Configuration Reference
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- **Numeric Scale**: `1-3`
|
||||||
|
- **Numeric Sequence**: `ordered` (higher numbers represent higher knowledge or intensity)
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
- **File Name** (required): Target file(s) for commenting.
|
||||||
|
- **Comment Detail** (`1-3`): Depth of each explanation (default `2`).
|
||||||
|
- **Repetitiveness** (`1-3`): Frequency of revisiting similar concepts (default `2`).
|
||||||
|
- **Educational Nature**: Domain focus (default `Computer Science`).
|
||||||
|
- **User Knowledge** (`1-3`): General CS/SE familiarity (default `2`).
|
||||||
|
- **Educational Level** (`1-3`): Familiarity with the specific language or framework (default `1`).
|
||||||
|
- **Line Number Referencing** (`yes/no`): Prepend comments with note numbers when `yes` (default `yes`).
|
||||||
|
- **Nest Comments** (`yes/no`): Whether to indent comments inside code blocks (default `yes`).
|
||||||
|
- **Fetch List**: Optional URLs for authoritative references.
|
||||||
|
|
||||||
|
If a configurable element is missing, use the default value. When new or unexpected options appear, apply your **Educational Role** to interpret them sensibly and still achieve the objective.
|
||||||
|
|
||||||
|
### Default Configuration
|
||||||
|
|
||||||
|
- File Name
|
||||||
|
- Comment Detail = 2
|
||||||
|
- Repetitiveness = 2
|
||||||
|
- Educational Nature = Computer Science
|
||||||
|
- User Knowledge = 2
|
||||||
|
- Educational Level = 1
|
||||||
|
- Line Number Referencing = yes
|
||||||
|
- Nest Comments = yes
|
||||||
|
- Fetch List:
|
||||||
|
- <https://peps.python.org/pep-0263/>
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Missing File
|
||||||
|
|
||||||
|
```text
|
||||||
|
[user]
|
||||||
|
> /add-educational-comments
|
||||||
|
[agent]
|
||||||
|
> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom Configuration
|
||||||
|
|
||||||
|
```text
|
||||||
|
[user]
|
||||||
|
> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no
|
||||||
|
```
|
||||||
|
|
||||||
|
Interpret `Line Numer = no` as `Line Number Referencing = no` and adjust behavior accordingly while maintaining all rules above.
|
||||||
|
|
||||||
|
## Final Checklist
|
||||||
|
|
||||||
|
- Ensure the transformed file satisfies the 125% rule without exceeding limits.
|
||||||
|
- Keep encoding, end-of-line style, and indentation unchanged.
|
||||||
|
- Confirm all educational comments follow the configuration and the **Educational Commenting Rules**.
|
||||||
|
- Provide clarifying suggestions only when they aid learning.
|
||||||
|
- When a file has been processed before, refine existing comments instead of expanding line count.
|
||||||
27
prompts/finalize-agent-prompt.prompt.md
Normal file
27
prompts/finalize-agent-prompt.prompt.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
mode: 'agent'
|
||||||
|
description: 'Finalize prompt file using the role of an AI agent to polish the prompt for the end user.'
|
||||||
|
tools: ['edit/editFiles']
|
||||||
|
---
|
||||||
|
|
||||||
|
# Finalize Agent Prompt
|
||||||
|
|
||||||
|
## Current Role
|
||||||
|
|
||||||
|
You are an AI agent who knows what works best for the prompt files you have
|
||||||
|
seen and the feedback you have received. Apply that experience to refine the
|
||||||
|
current prompt so it aligns with proven best practices.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- A prompt file must be provided. If none accompanies the request, ask for the
|
||||||
|
file before proceeding.
|
||||||
|
- Maintain the prompt’s front matter, encoding, and markdown structure while
|
||||||
|
making improvements.
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
1. Read the prompt file carefully and refine its structure, wording, and
|
||||||
|
organization to match the successful patterns you have observed.
|
||||||
|
2. Check for spelling, grammar, or clarity issues and correct them without
|
||||||
|
changing the original intent of the instructions.
|
||||||
151
prompts/shuffle-json-data.prompt.md
Normal file
151
prompts/shuffle-json-data.prompt.md
Normal file
@ -0,0 +1,151 @@
|
|||||||
|
---
|
||||||
|
mode: 'agent'
|
||||||
|
description: 'Shuffle repetitive JSON objects safely by validating schema consistency before randomising entries.'
|
||||||
|
tools: ['edit/editFiles', 'runInTerminal', 'pylanceRunCodeSnippet']
|
||||||
|
---
|
||||||
|
|
||||||
|
# Shuffle JSON Data
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Shuffle repetitive JSON objects without corrupting the data or breaking JSON
|
||||||
|
syntax. Always validate the input file first. If a request arrives without a
|
||||||
|
data file, pause and ask for one. Only proceed after confirming the JSON can be
|
||||||
|
shuffled safely.
|
||||||
|
|
||||||
|
## Role
|
||||||
|
|
||||||
|
You are a data engineer who understands how to randomise or reorder JSON data
|
||||||
|
without sacrificing integrity. Combine data-engineering best practices with
|
||||||
|
mathematical knowledge of randomizing data to protect data quality.
|
||||||
|
|
||||||
|
- Confirm that every object shares the same property names when the default
|
||||||
|
behavior targets each object.
|
||||||
|
- Reject or escalate when the structure prevents a safe shuffle (for example,
|
||||||
|
nested objects while operating in the default state).
|
||||||
|
- Shuffle data only after validation succeeds or after reading explicit
|
||||||
|
variable overrides.
|
||||||
|
|
||||||
|
## Objectives
|
||||||
|
|
||||||
|
1. Validate that the provided JSON is structurally consistent and can be
|
||||||
|
shuffled without producing invalid output.
|
||||||
|
2. Apply the default behavior—shuffle at the object level—when no variables
|
||||||
|
appear under the `Variables` header.
|
||||||
|
3. Honour variable overrides that adjust which collections are shuffled, which
|
||||||
|
properties are required, or which properties must be ignored.
|
||||||
|
|
||||||
|
## Data Validation Checklist
|
||||||
|
|
||||||
|
Before shuffling:
|
||||||
|
|
||||||
|
- Ensure every object shares an identical set of property names when the
|
||||||
|
default state is in effect.
|
||||||
|
- Confirm there are no nested objects in the default state.
|
||||||
|
- Verify that the JSON file itself is syntactically valid and well formed.
|
||||||
|
- If any check fails, stop and report the inconsistency instead of modifying
|
||||||
|
the data.
|
||||||
|
|
||||||
|
## Acceptable JSON
|
||||||
|
|
||||||
|
When the default behavior is active, acceptable JSON resembles the following
|
||||||
|
pattern:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"VALID_PROPERTY_NAME-a": "value",
|
||||||
|
"VALID_PROPERTY_NAME-b": "value"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"VALID_PROPERTY_NAME-a": "value",
|
||||||
|
"VALID_PROPERTY_NAME-b": "value"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Unacceptable JSON (Default State)
|
||||||
|
|
||||||
|
If the default behavior is active, reject files that contain nested objects or
|
||||||
|
inconsistent property names. For example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"VALID_PROPERTY_NAME-a": {
|
||||||
|
"VALID_PROPERTY_NAME-a": "value",
|
||||||
|
"VALID_PROPERTY_NAME-b": "value"
|
||||||
|
},
|
||||||
|
"VALID_PROPERTY_NAME-b": "value"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"VALID_PROPERTY_NAME-a": "value",
|
||||||
|
"VALID_PROPERTY_NAME-b": "value",
|
||||||
|
"VALID_PROPERTY_NAME-c": "value"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
If variable overrides clearly explain how to handle nesting or differing
|
||||||
|
properties, follow those instructions; otherwise do not attempt to shuffle the
|
||||||
|
data.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
1. **Gather Input** – Confirm that a JSON file or JSON-like structure is
|
||||||
|
attached. If not, pause and request the data file.
|
||||||
|
2. **Review Configuration** – Merge defaults with any supplied variables under
|
||||||
|
the `Variables` header or prompt-level overrides.
|
||||||
|
3. **Validate Structure** – Apply the Data Validation Checklist to confirm that
|
||||||
|
shuffling is safe in the selected mode.
|
||||||
|
4. **Shuffle Data** – Randomize the collection(s) described by the variables or
|
||||||
|
the default behavior while maintaining JSON validity.
|
||||||
|
5. **Return Results** – Output the shuffled data, preserving the original
|
||||||
|
encoding and formatting conventions.
|
||||||
|
|
||||||
|
## Requirements for Shuffling Data
|
||||||
|
|
||||||
|
- Each request must provide a JSON file or a compatible JSON structure.
|
||||||
|
- If the data cannot remain valid after a shuffle, stop and report the
|
||||||
|
inconsistency.
|
||||||
|
- Observe the default state when no overrides are supplied.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
Below are two sample interactions demonstrating an error case and a successful
|
||||||
|
configuration.
|
||||||
|
|
||||||
|
### Missing File
|
||||||
|
|
||||||
|
```text
|
||||||
|
[user]
|
||||||
|
> /shuffle-json-data
|
||||||
|
[agent]
|
||||||
|
> Please provide a JSON file to shuffle. Preferably as chat variable or attached context.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom Configuration
|
||||||
|
|
||||||
|
```text
|
||||||
|
[user]
|
||||||
|
> /shuffle-json-data #file:funFacts.json ignoreProperties = "year", "category"; requiredProperties = "fact"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Default State
|
||||||
|
|
||||||
|
Unless variables in this prompt or in a request override the defaults, treat the
|
||||||
|
input as follows:
|
||||||
|
|
||||||
|
- fileName = **REQUIRED**
|
||||||
|
- ignoreProperties = none
|
||||||
|
- requiredProperties = first set of properties from the first object
|
||||||
|
- nesting = false
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
|
||||||
|
When provided, the following variables override the default state. Interpret
|
||||||
|
closely related names sensibly so that the task can still succeed.
|
||||||
|
|
||||||
|
- ignoreProperties
|
||||||
|
- requiredProperties
|
||||||
|
- nesting
|
||||||
Loading…
x
Reference in New Issue
Block a user