Skip to content

Conversation

@PlagueHO
Copy link
Contributor

@PlagueHO PlagueHO commented Jul 7, 2025

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

Adds the following prompt files:

Name Example File Usage
Create Architectural Decision Record create-architectural-decision-record.prompt.md Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation.
Create GitHub Issue from Specification create-github-issue-feature-from-specification.prompt.md Create GitHub Issue for feature request from specification file using feature_request.yml template.
Create GitHub Issue from Implementation Plan create-github-issues-feature-from-implementation-plan.prompt.md Create GitHub Issues from implementation plan phases using feature_request.yml or chore_request.yml templates.
Create GitHub Issues for Unmet Specification Requirements create-github-issues-for-unmet-specification-requirements.prompt.md Create GitHub Issues for unimplemented requirements from specification files using feature_request.yml template.
Create Implementation Plan create-implementation-plan.prompt.md Create a new implementation plan file for new features, refactoring existing code or upgrading packages, design, architecture or infrastructure.
Create LLMs.txt File from Repository Structure create-llms.prompt.md Create an llms.txt file from scratch based on repository structure following the llms.txt specification at https://llmstxt.org/
Generate Standard OO Component Documentation create-oo-component-documentation.prompt.md Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards.
Create Specification create-specification.prompt.md Create a new specification file for the solution, optimized for Generative AI consumption.
.NET/C# Best Practices dotnet-best-practices.prompt.md Ensure .NET/C# code meets best practices for the solution/project.
.NET/C# Design Pattern Review dotnet-design-pattern-review.prompt.md Review the C#/.NET code for design pattern implementation and suggest improvements.
Suggest Awesome GitHub Copilot Chatmodes suggest-awesome-github-copilot-chatmodes.prompt.md Suggest relevant GitHub Copilot chatmode files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing chatmodes in this repository.
Suggest Awesome GitHub Copilot Prompts suggest-awesome-github-copilot-prompts.prompt.md Suggest relevant GitHub Copilot prompt files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing prompts in this repository.
Suggest GitHub Copilot Chatmodes suggest-github-copilot-chatmodes.prompt.md Suggest relevant GitHub Copilot chatmode files from a GitHub repository based on current repository context and chat history, avoiding duplicates with existing chatmodes in this repository.
Suggest GitHub Copilot Prompts suggest-github-copilot-prompts.prompt.md Suggest relevant GitHub Copilot prompt files from a GitHub repository based on current repository context and chat history, avoiding duplicates with existing prompts in this repository.
Update Azure Verified Modules in Bicep Files update-avm-modules-in-bicep.prompt.md Update Azure Verified Modules (AVM) to latest versions in Bicep files.
Implementation Plan Update update-implementation-plan.prompt.md Update an existing implementation plan file with new or update requirements to provide new features, refactoring existing code or upgrading packages, design, architecture or infrastructure.
Update LLMs.txt File update-llms.prompt.md Update the llms.txt file in the root folder to reflect changes in documentation or specifications following the llms.txt specification at https://llmstxt.org/
Update Markdown File Index update-markdown-file-index.prompt.md Update a markdown file section with an index/table of files from a specified folder.
Update Standard OO Component Documentation update-oo-component-documentation.prompt.md Update existing object-oriented component documentation following industry best practices and architectural documentation standards.
Update Specification 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.

Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify):

Additional Notes

This includes the prompts:
Suggest Awesome GitHub Copilot Prompts
Suggest Awesome GitHub Copilot Chatmodes

These can be used to discover and download further prompts/chat modes from the repo. Haven't implement a instructions one yet.

By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

…b Copilot suggestions

- Introduced a comprehensive prompt for ensuring .NET/C# code adheres to best practices, covering documentation, design patterns, dependency injection, resource management, async patterns, testing standards, configuration, AI integration, error handling, performance, security, and code quality.
- Added a prompt for reviewing C#/.NET code for design pattern implementation, providing a checklist for required patterns, architecture, best practices, SOLID principles, performance, maintainability, testability, security, documentation, code clarity, and clean code.
- Created prompts for suggesting relevant GitHub Copilot chatmodes and prompts based on the current repository context, including a structured process for fetching available chatmodes/prompts, scanning local files, and presenting options with rationale.
- Developed a prompt for updating Azure Verified Modules (AVM) in Bicep files, detailing the process for scanning, checking for updates, validating, and handling breaking changes.
- Implemented a prompt for updating implementation plans with new requirements, ensuring machine-readable output and adherence to a strict template.
- Added a prompt for updating the llms.txt file to reflect changes in documentation or specifications, focusing on compliance with the llmstxt specification.
- Created a prompt for updating markdown file indices with files from specified folders, including options for table structures and update strategies.
- Developed a prompt for updating object-oriented component documentation, following industry best practices and ensuring alignment with current implementations.
- Added a prompt for updating specification files, emphasizing clarity, structure, and compliance with established documentation standards.
Copilot AI review requested due to automatic review settings July 7, 2025 01:37
- Renamed prompt title for clarity.
- Added spacing for improved readability.
- Enhanced structure to ensure compliance with template validation rules.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds 18 new AI-guided prompt files covering tasks from ADR creation to spec updates, and updates the README to list each new prompt for easy installation.

  • Introduced prompts for specification management, implementation plans, LLM guidance, OO documentation, Azure module updates, GitHub Issue automation, and .NET best practices/pattern reviews.
  • Added “Suggest Awesome” prompts to surface relevant Copilot prompts/chatmodes from the awesome-copilot repo.
  • Updated README.md to include install badges for all new prompt files.

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
prompts/update-specification.prompt.md New agent prompt to update existing spec files
prompts/update-oo-component-documentation.prompt.md New agent prompt to refresh OO component docs
prompts/update-markdown-file-index.prompt.md New agent prompt to generate/update a markdown index
prompts/update-llms.prompt.md New agent prompt to update llms.txt
prompts/update-implementation-plan.prompt.md New agent prompt to update implementation plans
prompts/update-avm-modules-in-bicep.prompt.md New agent prompt to update AVM versions in Bicep
prompts/suggest-awesome-github-copilot-prompts.prompt.md New agent prompt to suggest Copilot prompts
prompts/suggest-awesome-github-copilot-chatmodes.prompt.md New agent prompt to suggest Copilot chatmodes
prompts/dotnet-design-pattern-review.prompt.md New agent prompt for .NET design pattern reviews
prompts/dotnet-best-practices.prompt.md New agent prompt for .NET/C# best practices
prompts/create-specification.prompt.md New agent prompt to create spec files
prompts/create-oo-component-documentation.prompt.md New agent prompt to generate OO component docs
prompts/create-llms.prompt.md New agent prompt to create llms.txt from scratch
prompts/create-implementation-plan.prompt.md New agent prompt to create implementation plans
prompts/create-github-issues-for-unmet-specification-requirements.prompt.md New agent prompt to open issues for unmet specs
prompts/create-github-issues-feature-from-implementation-plan.prompt.md New agent prompt to open issues from plan phases
prompts/create-github-issue-feature-from-specification.prompt.md New agent prompt to open an issue from a spec file
prompts/create-architectural-decision-record.prompt.md New agent prompt to create ADR documents
README.md Updated to list/install all new prompts
Comments suppressed due to low confidence (1)

prompts/update-specification.prompt.md:22

  • Typo: 'highlevel' should be hyphenated as 'high-level'.
The specification should be saved in the [/spec/](/spec/) directory and named according to the following convention: `[a-z0-9-]+.md`, where the name should be descriptive of the specification's content and starting with the highlevel purpose, which is one of [schema, tool, data, infrastructure, process, architecture, or design].

- Corrected "soltion" to "solution" in the prompt description.
@aaronpowell aaronpowell merged commit e1c7c7a into github:main Jul 7, 2025
2 checks passed
@PlagueHO PlagueHO deleted the add-chatmodes branch July 7, 2025 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants