From a0754dd249df187e080cc41f358faab66cdb2b2c Mon Sep 17 00:00:00 2001 From: James Montemagno Date: Wed, 2 Jul 2025 15:18:54 -0700 Subject: [PATCH] Delete outdated development instructions for Next.js + Tailwind and Python; add comprehensive guidelines for PostgreSQL DBA, Angular, ASP.NET REST APIs, Azure Functions with TypeScript, Bicep, Blazor, CMake with vcpkg, C#, .NET MAUI, GenAIScript, Terraform for Azure, localization, and markdown standards. --- README.md | 32 +++++++++---------- ...chatmode.md => postgresql-dba.chatmode.md} | 0 .../{angular.md => angular.instructions.md} | 4 +-- ...is.md => aspnet-rest-apis.instructions.md} | 1 + ...zure-functions-typescript.instructions.md} | 1 + ...bicep-code-best-practices.instructions.md} | 0 .../{blazor.md => blazor.instructions.md} | 0 ...e-vcpkg.md => cmake-vcpkg.instructions.md} | 1 + .../copilot-thought-logging.instructions.md | 1 - .../{csharp.md => csharp.instructions.md} | 1 + ...et-maui.md => dotnet-maui.instructions.md} | 18 +++++------ ...iscript.md => genaiscript.instructions.md} | 2 +- ...-terraform-code-for-azure.instructions.md} | 0 ...zation.md => localization.instructions.md} | 0 .../{markdown.md => markdown.instructions.md} | 0 ...ind.md => nextjs-tailwind.instructions.md} | 1 + .../{python.md => python.instructions.md} | 1 + 17 files changed, 34 insertions(+), 29 deletions(-) rename chatmodes/{PostgreSQL DBA.chatmode.md => postgresql-dba.chatmode.md} (100%) rename instructions/{angular.md => angular.instructions.md} (97%) rename instructions/{aspnet-rest-apis.md => aspnet-rest-apis.instructions.md} (99%) rename instructions/{azure-functions-typescript.md => azure-functions-typescript.instructions.md} (88%) rename instructions/{bicep-code-best-practices.md => bicep-code-best-practices.instructions.md} (100%) rename instructions/{blazor.md => blazor.instructions.md} (100%) rename instructions/{cmake-vcpkg.md => cmake-vcpkg.instructions.md} (91%) rename instructions/{csharp.md => csharp.instructions.md} (99%) rename instructions/{dotnet-maui.md => dotnet-maui.instructions.md} (84%) rename instructions/{genaiscript.md => genaiscript.instructions.md} (100%) rename instructions/{generate-modern-terraform-code-for-azure.md => generate-modern-terraform-code-for-azure.instructions.md} (100%) rename instructions/{localization.md => localization.instructions.md} (100%) rename instructions/{markdown.md => markdown.instructions.md} (100%) rename instructions/{nextjs-tailwind.md => nextjs-tailwind.instructions.md} (96%) rename instructions/{python.md => python.instructions.md} (98%) diff --git a/README.md b/README.md index f70435e..2d6f916 100644 --- a/README.md +++ b/README.md @@ -21,21 +21,21 @@ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices: -- [Angular Development Instructions](instructions/angular.md) - Angular-specific coding standards and best practices -- [ASP.NET REST API Development](instructions/aspnet-rest-apis.md) - Guidelines for building REST APIs with ASP.NET -- [Azure Functions Typescript](instructions/azure-functions-typescript.md) - TypeScript patterns for Azure Functions -- [Bicep Code Best Practices](instructions/bicep-code-best-practices.md) - Infrastructure as Code with Bicep -- [Blazor](instructions/blazor.md) - Blazor component and application patterns -- [Cmake Vcpkg](instructions/cmake-vcpkg.md) - C++ project configuration and package management +- [Angular Development Instructions](instructions/angular.instructions.md) - Angular-specific coding standards and best practices +- [ASP.NET REST API Development](instructions/aspnet-rest-apis.instructions.md) - Guidelines for building REST APIs with ASP.NET +- [Azure Functions Typescript](instructions/azure-functions-typescript.instructions.md) - TypeScript patterns for Azure Functions +- [Bicep Code Best Practices](instructions/bicep-code-best-practices.instructions.md) - Infrastructure as Code with Bicep +- [Blazor](instructions/blazor.instructions.md) - Blazor component and application patterns +- [Cmake Vcpkg](instructions/cmake-vcpkg.instructions.md) - C++ project configuration and package management - [Copilot Process tracking Instructions](instructions/copilot-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 -- [C# Development](instructions/csharp.md) - Guidelines for building C# applications -- [Dotnet Maui](instructions/dotnet-maui.md) - MAUI component and application patterns -- [Genaiscript](instructions/genaiscript.md) - AI-powered script generation guidelines -- [Generate Modern Terraform Code For Azure](instructions/generate-modern-terraform-code-for-azure.md) - Guidelines for generating modern Terraform code for Azure -- [Guidance for Localization](instructions/localization.md) - Guidelines for localizing markdown documents -- [Markdown](instructions/markdown.md) - Documentation and content creation standards -- [Next.js + Tailwind Development Instructions](instructions/nextjs-tailwind.md) - Next.js + Tailwind development standards and instructions -- [Python Coding Conventions](instructions/python.md) - Python coding conventions and guidelines +- [C# Development](instructions/csharp.instructions.md) - Guidelines for building C# applications +- [Dotnet Maui](instructions/dotnet-maui.instructions.md) - MAUI component and application patterns +- [Genaiscript](instructions/genaiscript.instructions.md) - AI-powered script generation guidelines +- [Generate Modern Terraform Code For Azure](instructions/generate-modern-terraform-code-for-azure.instructions.md) - Guidelines for generating modern Terraform code for Azure +- [Guidance for Localization](instructions/localization.instructions.md) - Guidelines for localizing markdown documents +- [Markdown](instructions/markdown.instructions.md) - Documentation and content creation standards +- [Next.js + Tailwind Development Instructions](instructions/nextjs-tailwind.instructions.md) - Next.js + Tailwind development standards and instructions +- [Python Coding Conventions](instructions/python.instructions.md) - Python coding conventions and guidelines > 💡 **Usage**: Copy these instructions to your `.github/copilot-instructions.md` file or create task-specific `.github/.instructions.md` files in your workspace's `.github/instructions` folder. @@ -72,8 +72,8 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi 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%20DBA.chatmode.md) - Work with PostgreSQL databases using the PostgreSQL extension. +- [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 diff --git a/chatmodes/PostgreSQL DBA.chatmode.md b/chatmodes/postgresql-dba.chatmode.md similarity index 100% rename from chatmodes/PostgreSQL DBA.chatmode.md rename to chatmodes/postgresql-dba.chatmode.md diff --git a/instructions/angular.md b/instructions/angular.instructions.md similarity index 97% rename from instructions/angular.md rename to instructions/angular.instructions.md index 654c3da..0f5a133 100644 --- a/instructions/angular.md +++ b/instructions/angular.instructions.md @@ -1,6 +1,6 @@ --- -description: | - Angular-specific coding standards and best practices +description: Angular-specific coding standards and best practices +applyTo: "**/*.ts, **/*.html, **/*.scss, **/*.css" --- # Angular Development Instructions diff --git a/instructions/aspnet-rest-apis.md b/instructions/aspnet-rest-apis.instructions.md similarity index 99% rename from instructions/aspnet-rest-apis.md rename to instructions/aspnet-rest-apis.instructions.md index 9981e7b..cc27c77 100644 --- a/instructions/aspnet-rest-apis.md +++ b/instructions/aspnet-rest-apis.instructions.md @@ -1,5 +1,6 @@ --- description: Guidelines for building REST APIs with ASP.NET +applyTo: "**/*.cs, **/*.json" --- # ASP.NET REST API Development diff --git a/instructions/azure-functions-typescript.md b/instructions/azure-functions-typescript.instructions.md similarity index 88% rename from instructions/azure-functions-typescript.md rename to instructions/azure-functions-typescript.instructions.md index 0c2c4a5..b7941d7 100644 --- a/instructions/azure-functions-typescript.md +++ b/instructions/azure-functions-typescript.instructions.md @@ -1,5 +1,6 @@ --- description: TypeScript patterns for Azure Functions +applyTo: "**/*.ts, **/*.js, **/*.json" --- ## Guidance for Code Generation diff --git a/instructions/bicep-code-best-practices.md b/instructions/bicep-code-best-practices.instructions.md similarity index 100% rename from instructions/bicep-code-best-practices.md rename to instructions/bicep-code-best-practices.instructions.md diff --git a/instructions/blazor.md b/instructions/blazor.instructions.md similarity index 100% rename from instructions/blazor.md rename to instructions/blazor.instructions.md diff --git a/instructions/cmake-vcpkg.md b/instructions/cmake-vcpkg.instructions.md similarity index 91% rename from instructions/cmake-vcpkg.md rename to instructions/cmake-vcpkg.instructions.md index 2e10e97..d1e7c23 100644 --- a/instructions/cmake-vcpkg.md +++ b/instructions/cmake-vcpkg.instructions.md @@ -1,5 +1,6 @@ --- 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 index 1a69ab8..15b8f4d 100644 --- a/instructions/copilot-thought-logging.instructions.md +++ b/instructions/copilot-thought-logging.instructions.md @@ -1,6 +1,5 @@ --- applyTo: '**' -mode: "agent" description: 'See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed' --- diff --git a/instructions/csharp.md b/instructions/csharp.instructions.md similarity index 99% rename from instructions/csharp.md rename to instructions/csharp.instructions.md index c12d7aa..775f3f6 100644 --- a/instructions/csharp.md +++ b/instructions/csharp.instructions.md @@ -1,5 +1,6 @@ --- description: Guidelines for building C# applications +applyTo: "**/*.cs" --- # C# Development diff --git a/instructions/dotnet-maui.md b/instructions/dotnet-maui.instructions.md similarity index 84% rename from instructions/dotnet-maui.md rename to instructions/dotnet-maui.instructions.md index e5e7e41..2520b02 100644 --- a/instructions/dotnet-maui.md +++ b/instructions/dotnet-maui.instructions.md @@ -1,12 +1,12 @@ --- -description: MAUI component and application patterns -appliesTo: "**/*.xaml, **/*.cs" +description: .NET MAUI component and application patterns +applyTo: "**/*.xaml, **/*.cs" --- -## MAUI Code Style and Structure +## .NET MAUI Code Style and Structure -- Write idiomatic and efficient MAUI and C# code. -- Follow .NET and MAUI conventions. +- Write idiomatic and efficient .NET MAUI and C# code. +- Follow .NET and .NET MAUI conventions. - Prefer inline functions for smaller components but separate complex logic into code-behind or service classes. - Async/await should be used where applicable to ensure non-blocking UI operations. @@ -16,16 +16,16 @@ appliesTo: "**/*.xaml, **/*.cs" - Use camelCase for private fields and local variables. - Prefix interface names with "I" (e.g., IUserService). -## MAUI and .NET Specific Guidelines +## .NET MAUI and .NET Specific Guidelines -- Utilize MAUI's built-in features for component lifecycle (e.g. OnAppearing, OnDisappearing). +- Utilize .NET MAUI's built-in features for component lifecycle (e.g. OnAppearing, OnDisappearing). - Use data binding effectively with {Binding}. -- Structure MAUI components and services following Separation of Concerns. +- Structure .NET MAUI components and services following Separation of Concerns. - Always use the latest version C#, currently C# 13 features like record types, pattern matching, and global usings. ## Error Handling and Validation -- Implement proper error handling for MAUI pages and API calls. +- Implement proper error handling for .NET MAUI pages and API calls. - Use logging for error tracking in the backend and consider capturing UI-level errors in MAUI with tools like MAUI Community Toolkit's Logger. - Implement validation using FluentValidation or DataAnnotations in forms. diff --git a/instructions/genaiscript.md b/instructions/genaiscript.instructions.md similarity index 100% rename from instructions/genaiscript.md rename to instructions/genaiscript.instructions.md index 7a14eeb..a7b4274 100644 --- a/instructions/genaiscript.md +++ b/instructions/genaiscript.instructions.md @@ -1,6 +1,6 @@ --- -applyTo: "**/*.genai.*" description: AI-powered script generation guidelines +applyTo: "**/*.genai.*" --- ## Role diff --git a/instructions/generate-modern-terraform-code-for-azure.md b/instructions/generate-modern-terraform-code-for-azure.instructions.md similarity index 100% rename from instructions/generate-modern-terraform-code-for-azure.md rename to instructions/generate-modern-terraform-code-for-azure.instructions.md diff --git a/instructions/localization.md b/instructions/localization.instructions.md similarity index 100% rename from instructions/localization.md rename to instructions/localization.instructions.md diff --git a/instructions/markdown.md b/instructions/markdown.instructions.md similarity index 100% rename from instructions/markdown.md rename to instructions/markdown.instructions.md diff --git a/instructions/nextjs-tailwind.md b/instructions/nextjs-tailwind.instructions.md similarity index 96% rename from instructions/nextjs-tailwind.md rename to instructions/nextjs-tailwind.instructions.md index 36d56b8..3af8d1a 100644 --- a/instructions/nextjs-tailwind.md +++ b/instructions/nextjs-tailwind.instructions.md @@ -1,5 +1,6 @@ --- description: Next.js + Tailwind development standards and instructions +applyTo: "**/*.tsx, **/*.ts, **/*.jsx, **/*.js, **/*.css" --- # Next.js + Tailwind Development Instructions diff --git a/instructions/python.md b/instructions/python.instructions.md similarity index 98% rename from instructions/python.md rename to instructions/python.instructions.md index 9635043..42ae936 100644 --- a/instructions/python.md +++ b/instructions/python.instructions.md @@ -1,5 +1,6 @@ --- description: Python coding conventions and guidelines +applyTo: "**/*.py" --- # Python Coding Conventions