Update documentation and prompts for consistency and clarity

jamesmontemagno · jamesmontemagno · commit 17405dfc5452 · 2025-07-02T16:35:24.000-07:00
- Standardized description formatting in various markdown files to use single quotes.
- Added error handling utility in update-readme.js for safer file operations.
- Improved title extraction logic in update-readme.js to handle frontmatter more robustly.
- Updated chat modes section in README to reflect new emoji and sorted chat mode links.
- Cleaned up various instruction files for better readability and consistency.
- Ensured all markdown files end with a newline for better compatibility with version control.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -71,4 +71,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -82,4 +82,4 @@ Please note that this project is released with a [Contributor Code of Conduct](C
 
 ## License
 
-By contributing to this repository, you agree that your contributions will be licensed under the MIT License.
+By contributing to this repository, you agree that your contributions will be licensed under the MIT License.
diff --git a/README.md b/README.md
@@ -68,18 +68,15 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
 
 > 💡 **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
 
 Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows.
 
-- [4.1 Beast Mode](chatmodes/4.1-beast.chatmode.md) - A custom prompt to get GPT 4.1 to behave like a top-notch coding agent.
-- [Database Administrator Chat Mode](chatmodes/postgresql-dba.chatmode.md) - Work with PostgreSQL databases using the PostgreSQL extension.
-- [Debug Mode Instructions](chatmodes/debug.chatmode.md) - Debug your application to find and fix a bug
-- [Planning mode instructions](chatmodes/planner.chatmode.md) - Generate an implementation plan for new features or refactoring existing code.
-- [Refine Requirement or Issue Chat Mode](chatmodes/refine-issue.chatmode.md) - Refine the requirement or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs
-
-
-> 💡 **Usage**: Create new chat modes using the command `Chat: Configure Chat Modes...`, then switch your chat mode in the Chat input from _Agent_ or _Ask_ to your own mode.
+- [4.1 Beast Mode](chatmodes/4.1-beast.chatmode.md)
+- [Debug Mode Instructions](chatmodes/debug.chatmode.md)
+- [Planning mode instructions](chatmodes/planner.chatmode.md)
+- [Database Administrator Chat Mode](chatmodes/postgresql-dba.chatmode.md)
+- [Refine Requirement or Issue Chat Mode](chatmodes/refine-issue.chatmode.md)
 
 ## 📚 Additional Resources
 
diff --git a/SECURITY.md b/SECURITY.md
@@ -28,4 +28,4 @@ This information will help us triage your report more quickly.
 
 ## Policy
 
-See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)
+See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -12,4 +12,4 @@ Please include one of the following statements file:
 - 
 ## GitHub Support Policy
 
-Support for this project is limited to the resources listed above.
+Support for this project is limited to the resources listed above.
diff --git a/chatmodes/4.1-Beast.chatmode.md b/chatmodes/4.1-Beast.chatmode.md
@@ -133,4 +133,4 @@ I'm now checking to ensure that these changes will correctly update the UI when
 4. Reuse previous context unless something has changed.
 5. If redoing work, explain briefly *why* it’s necessary and proceed.
 
-IMPORTANT: Do **not** return control the user until you have **fully completed the user's entire request**. All items in your todo list MUST be checked off. Failure to do so will result in a bad rating for you.
+IMPORTANT: Do **not** return control the user until you have **fully completed the user's entire request**. All items in your todo list MUST be checked off. Failure to do so will result in a bad rating for you.
diff --git a/chatmodes/debug.chatmode.md b/chatmodes/debug.chatmode.md
@@ -1,5 +1,5 @@
 ---
-description: Debug your application to find and fix a bug
+description: 'Debug your application to find and fix a bug'
 tools: ['codebase', 'readFiles', 'editFiles', 'githubRepo', 'runCommands', 'fetch', 'search', 'usages', 'findTestFiles', 'get_errors', 'test_failure', 'run_in_terminal', 'get_terminal_output']
 ---
 
diff --git a/chatmodes/planner.chatmode.md b/chatmodes/planner.chatmode.md
@@ -1,5 +1,5 @@
 ---
-description: Generate an implementation plan for new features or refactoring existing code.
+description: 'Generate an implementation plan for new features or refactoring existing code.'
 tools: ['codebase', 'fetch', 'findTestFiles', 'githubRepo', 'search', 'usages']
 ---
 # Planning mode instructions
@@ -11,4 +11,4 @@ The plan consists of a Markdown document that describes the implementation plan,
 * Overview: A brief description of the feature or refactoring task.
 * Requirements: A list of requirements for the feature or refactoring task.
 * Implementation Steps: A detailed list of steps to implement the feature or refactoring task.
-* Testing: A list of tests that need to be implemented to verify the feature or refactoring task.
+* Testing: A list of tests that need to be implemented to verify the feature or refactoring task.
diff --git a/instructions/angular.instructions.md b/instructions/angular.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Angular-specific coding standards and best practices
-applyTo: "**/*.ts, **/*.html, **/*.scss, **/*.css"
+description: 'Angular-specific coding standards and best practices'
+applyTo: '**/*.ts, **/*.html, **/*.scss, **/*.css'
 ---
 
 # Angular Development Instructions
diff --git a/instructions/aspnet-rest-apis.instructions.md b/instructions/aspnet-rest-apis.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Guidelines for building REST APIs with ASP.NET
-applyTo: "**/*.cs, **/*.json"
+description: 'Guidelines for building REST APIs with ASP.NET'
+applyTo: '**/*.cs, **/*.json'
 ---
 
 # ASP.NET REST API Development
diff --git a/instructions/azure-functions-typescript.instructions.md b/instructions/azure-functions-typescript.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: TypeScript patterns for Azure Functions
-applyTo: "**/*.ts, **/*.js, **/*.json"
+description: 'TypeScript patterns for Azure Functions'
+applyTo: '**/*.ts, **/*.js, **/*.json'
 ---
 
 ## Guidance for Code Generation
@@ -11,4 +11,4 @@ applyTo: "**/*.ts, **/*.js, **/*.json"
 - Ask before adding any extra dependencies to the project
 - The API is built using Azure Functions using `@azure/functions@4` package.
 - Each endpoint should have its own function file, and use the following naming convention: `src/functions/<resource-name>-<http-verb>.ts`
-- When making changes to the API, make sure to update the OpenAPI schema (if it exists) and `README.md` file accordingly.
+- When making changes to the API, make sure to update the OpenAPI schema (if it exists) and `README.md` file accordingly.
diff --git a/instructions/bicep-code-best-practices.instructions.md b/instructions/bicep-code-best-practices.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Infrastructure as Code with Bicep
-applyTo: "**/*.bicep"
+description: 'Infrastructure as Code with Bicep'
+applyTo: '**/*.bicep'
 ---
 
 ## Naming Conventions
diff --git a/instructions/blazor.instructions.md b/instructions/blazor.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Blazor component and application patterns
-applyTo: "**/*.razor, **/*.razor.cs, **/*.razor.css"
+description: 'Blazor component and application patterns'
+applyTo: '**/*.razor, **/*.razor.cs, **/*.razor.css'
 ---
 
 ## Blazor Code Style and Structure
diff --git a/instructions/cmake-vcpkg.instructions.md b/instructions/cmake-vcpkg.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: C++ project configuration and package management
-applyTo: "**/*.cmake, **/CMakeLists.txt, **/*.cpp, **/*.h, **/*.hpp"
+description: 'C++ project configuration and package management'
+applyTo: '**/*.cmake, **/CMakeLists.txt, **/*.cpp, **/*.h, **/*.hpp'
 ---
 
 This project uses vcpkg in manifest mode. Please keep this in mind when giving vcpkg suggestions. Do not provide suggestions like vcpkg install library, as they will not work as expected.
diff --git a/instructions/copilot-thought-logging.instructions.md b/instructions/copilot-thought-logging.instructions.md
@@ -59,4 +59,4 @@ description: 'See process Copilot is following where you can edit this to reshap
 - NEVER continue past current phase without user input
 - If you catch yourself being verbose, STOP and provide only required output
 - If you catch yourself about to skip a phase, STOP and go back to the correct phase
-- If you catch yourself combining phases, STOP and perform only the current phase
+- If you catch yourself combining phases, STOP and perform only the current phase
diff --git a/instructions/csharp.instructions.md b/instructions/csharp.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Guidelines for building C# applications
-applyTo: "**/*.cs"
+description: 'Guidelines for building C# applications'
+applyTo: '**/*.cs'
 ---
 
 # C# Development
diff --git a/instructions/dotnet-maui.instructions.md b/instructions/dotnet-maui.instructions.md
@@ -1,8 +1,10 @@
 ---
-description: .NET MAUI component and application patterns
-applyTo: "**/*.xaml, **/*.cs"
+description: '.NET MAUI component and application patterns'
+applyTo: '**/*.xaml, **/*.cs'
 ---
 
+# .NET MAUI
+
 ## .NET MAUI Code Style and Structure
 
 - Write idiomatic and efficient .NET MAUI and C# code.
diff --git a/instructions/genaiscript.instructions.md b/instructions/genaiscript.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: AI-powered script generation guidelines
-applyTo: "**/*.genai.*"
+description: 'AI-powered script generation guidelines'
+applyTo: '**/*.genai.*'
 ---
 
 ## Role
diff --git a/instructions/generate-modern-terraform-code-for-azure.instructions.md b/instructions/generate-modern-terraform-code-for-azure.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Guidelines for generating modern Terraform code for Azure
-applyTo: "**/*.tf"
+description: 'Guidelines for generating modern Terraform code for Azure'
+applyTo: '**/*.tf'
 ---
 
 ## 1. Use Latest Terraform and Providers
@@ -79,4 +79,4 @@ Use Terraform modules to group reusable infrastructure components. For any resou
 - **Consider implementing automated checks**:
   - CI pipeline
   - Pre-commit hooks
-  - Enforce formatting, linting, and basic validation
+  - Enforce formatting, linting, and basic validation
diff --git a/instructions/localization.instructions.md b/instructions/localization.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Guidelines for localizing markdown documents
-applyTo: "**/*.md"
+description: 'Guidelines for localizing markdown documents'
+applyTo: '**/*.md'
 ---
 
 # Guidance for Localization
diff --git a/instructions/markdown.instructions.md b/instructions/markdown.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Documentation and content creation standards
-applyTo: "**/*.md"
+description: 'Documentation and content creation standards'
+applyTo: '**/*.md'
 ---
 
 ## Markdown Content Rules
diff --git a/instructions/nextjs-tailwind.instructions.md b/instructions/nextjs-tailwind.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Next.js + Tailwind development standards and instructions
-applyTo: "**/*.tsx, **/*.ts, **/*.jsx, **/*.js, **/*.css"
+description: 'Next.js + Tailwind development standards and instructions'
+applyTo: '**/*.tsx, **/*.ts, **/*.jsx, **/*.js, **/*.css'
 ---
 
 # Next.js + Tailwind Development Instructions
@@ -69,4 +69,4 @@ Instructions for high-quality Next.js applications with Tailwind CSS styling and
 5. Add proper error handling
 6. Implement responsive styling
 7. Add loading states
-8. Write tests
+8. Write tests
diff --git a/instructions/python.instructions.md b/instructions/python.instructions.md
@@ -1,6 +1,6 @@
 ---
-description: Python coding conventions and guidelines
-applyTo: "**/*.py"
+description: 'Python coding conventions and guidelines'
+applyTo: '**/*.py'
 ---
 
 # Python Coding Conventions
@@ -53,4 +53,4 @@ def calculate_area(radius: float) -> float:
     """
     import math
     return math.pi * radius ** 2
-```
+```
diff --git a/prompts/aspnet-minimal-api-openapi.prompt.md b/prompts/aspnet-minimal-api-openapi.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems"]
-description: "Create ASP.NET Minimal API endpoints with proper OpenAPI documentation"
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems']
+description: 'Create ASP.NET Minimal API endpoints with proper OpenAPI documentation'
 ---
 
 Your goal is to help me create well-structured ASP.NET Minimal API endpoints with correct types and comprehensive OpenAPI/Swagger documentation.
diff --git a/prompts/az-cost-optimize.prompt.md b/prompts/az-cost-optimize.prompt.md
@@ -1,6 +1,6 @@
 ---
-mode: agent
-description: Analyze Azure resources used in the app (IaC files and/or resources in a target rg) and optimize costs - creating GitHub issues for identified optimizations.
+mode: 'agent'
+description: 'Analyze Azure resources used in the app (IaC files and/or resources in a target rg) and optimize costs - creating GitHub issues for identified optimizations.'
 ---
 
 ## Overview
@@ -301,4 +301,4 @@ This workflow analyzes Infrastructure-as-Code (IaC) files and Azure resources to
 - ✅ All recommendations include specific, executable Azure CLI commands
 - ✅ Priority scoring enables ROI-focused implementation
 - ✅ Architecture diagram accurately represents current state
-- ✅ User confirmation prevents unwanted issue creation
+- ✅ User confirmation prevents unwanted issue creation
diff --git a/prompts/comment-code-generate-a-tutorial.prompt.md b/prompts/comment-code-generate-a-tutorial.prompt.md
@@ -18,4 +18,4 @@ Transform this Python script into a polished, beginner-friendly project by refac
    - **How It Works:** A breakdown of the code logic based on the comments  
    - **Example Usage:** A code snippet showing how to use it  
    - **Sample Output:** (Optional) Include if the script returns visible results  
-   - Use clear, readable Markdown formatting
+   - Use clear, readable Markdown formatting
diff --git a/prompts/csharp-async.prompt.md b/prompts/csharp-async.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems"]
-description: "Get best practices for C# async programming"
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems']
+description: 'Get best practices for C# async programming'
 ---
 
 # C# Async Programming Best Practices
diff --git a/prompts/csharp-docs.prompt.md b/prompts/csharp-docs.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems"]
-description: "Ensure that C# types are documented with XML comments and follow best practices for documentation."
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems']
+description: 'Ensure that C# types are documented with XML comments and follow best practices for documentation.'
 ---
 
 # C# Documentation Best Practices
diff --git a/prompts/csharp-mstest.prompt.md b/prompts/csharp-mstest.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems", "search"]
-description: "Get best practices for MSTest unit testing, including data-driven tests"
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems', 'search']
+description: 'Get best practices for MSTest unit testing, including data-driven tests'
 ---
 
 # MSTest Best Practices
@@ -65,4 +65,4 @@ Your goal is to help me write effective unit tests with MSTest, covering both st
 * Group tests by feature or component
 * Use test categories with `[TestCategory("Category")]`
 * Use test priorities with `[Priority(1)]` for critical tests
-* Use `[Owner("DeveloperName")]` to indicate ownership
+* Use `[Owner("DeveloperName")]` to indicate ownership
diff --git a/prompts/csharp-nunit.prompt.md b/prompts/csharp-nunit.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems", "search"]
-description: "Get best practices for NUnit unit testing, including data-driven tests"
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems', 'search']
+description: 'Get best practices for NUnit unit testing, including data-driven tests'
 ---
 
 # NUnit Best Practices
diff --git a/prompts/csharp-xunit.prompt.md b/prompts/csharp-xunit.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems", "search"]
-description: "Get best practices for XUnit unit testing, including data-driven tests"
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems', 'search']
+description: 'Get best practices for XUnit unit testing, including data-driven tests'
 ---
 
 # XUnit Best Practices
diff --git a/prompts/ef-core.prompt.md b/prompts/ef-core.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["changes", "codebase", "editFiles", "problems", "runCommands"]
-description: "Get best practices for Entity Framework Core"
+mode: 'agent'
+tools: ['changes', 'codebase', 'editFiles', 'problems', 'runCommands']
+description: 'Get best practices for Entity Framework Core'
 ---
 
 # Entity Framework Core Best Practices
diff --git a/prompts/gen-specs-as-issues.prompt.md b/prompts/gen-specs-as-issues.prompt.md
@@ -157,4 +157,4 @@ Remember throughout this process:
 - Build a foundation that can be extended later
 - Consider the open-source community and contribution model
 
-This workflow embodiment of our approach should help maintain consistency in how features are specified and prioritized, ensuring that software projects evolve in a thoughtful, user-centered way.
+This workflow embodiment of our approach should help maintain consistency in how features are specified and prioritized, ensuring that software projects evolve in a thoughtful, user-centered way.
diff --git a/prompts/javascript-typescript-jest.prompt.md b/prompts/javascript-typescript-jest.prompt.md
@@ -1,5 +1,5 @@
 ---
-description: "Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns."
+description: 'Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns.'
 ---
 
 ### Test Structure
diff --git a/prompts/multi-stage-dockerfile.prompt.md b/prompts/multi-stage-dockerfile.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: "agent"
-tools: ["codebase"]
-description: "Create optimized multi-stage Dockerfiles for any language or framework"
+mode: 'agent'
+tools: ['codebase']
+description: 'Create optimized multi-stage Dockerfiles for any language or framework'
 ---
 
 Your goal is to help me create efficient multi-stage Dockerfiles that follow best practices, resulting in smaller, more secure container images.
diff --git a/prompts/my-issues.prompt.md b/prompts/my-issues.prompt.md
@@ -1,7 +1,7 @@
 ---
-mode: agent
+mode: 'agent'
 tools: ['githubRepo', 'github', 'get_issue', 'get_issue_comments', 'get_me', 'list_issues']
-description: "List my issues in the current repository"
+description: 'List my issues in the current repository'
 ---
 
 Search the current repo (using #githubRepo for the repo info) and list any issues you find (using #list_issues) that are assigned to me.
diff --git a/prompts/my-pull-requests.prompt.md b/prompts/my-pull-requests.prompt.md
diff --git a/standardize-frontmatter.js b/standardize-frontmatter.js
diff --git a/update-readme.js b/update-readme.js

Original file line number	Diff line number	Diff line change
`@@ -82,4 +82,4 @@ Please note that this project is released with a [Contributor Code of Conduct](C`
`82`	`82`
`83`	`83`	`## License`
`84`	`84`
`85`		`-By contributing to this repository, you agree that your contributions will be licensed under the MIT License.`
	`85`	`+By contributing to this repository, you agree that your contributions will be licensed under the MIT License.`
Original file line number	Diff line number	Diff line change
`@@ -28,4 +28,4 @@ This information will help us triage your report more quickly.`
`28`	`28`
`29`	`29`	`## Policy`
`30`	`30`
`31`		`-See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)`
	`31`	`+See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@ Please include one of the following statements file:`
`12`	`12`	`-`
`13`	`13`	`## GitHub Support Policy`
`14`	`14`
`15`		`-Support for this project is limited to the resources listed above.`
	`15`	`+Support for this project is limited to the resources listed above.`