feat(templates): add .github\copilot-instructions.md to bit Boilerplate #11020 (#11021)

Author: ysmoradi

src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md

@@ -0,0 +1,79 @@
+# copilot-instructions.md
+
+## Architecture & Project Structure
+
+- **Client Projects**: Multiple platform-specific clients sharing core infrastructure 
+  - `Client.Core`: Blazor pages, shared components, service, typescript and SCSS files.
+  - `Client.Web`: PWA Blazor WebAssembly.
+  - `Client.Maui`: Cross-platform MAUI based Blazor Hybrid app.
+  - `Client.Windows`: Windows forms based Blazor Hybrid app.
+
+- **Server Projects**: API and web
+  - `Server.Api`: Web API controllers, entity framework core db context, type configurations and migrations plus SignalR, Hangfire, models, services and mappers.
+  - `Server.Web`: Blazor Server, Auto and WebAssembly, with or without pre-rendering.
+
+- **Shared**: Dto classes, enums, interfaces etc.
+
+- **Boilerplate.Tests**: Integration api and UI tests using Playwright and MSTest.
+
+## Technology Stack
+
+### Technologies
+- **C# 13.0**
+- **ASP.NET Core 9.0**
+- **Blazor**: Component-based web UI framework
+- **MAUI**: Cross-platform app development
+- **ASP.NET Core Identity**: Authentication and authorization
+- **Entity Framework Core**: Data access
+- **SignalR**: Real-time communication 
+- **Hangfire**: Background job processing
+- **OData**: Advanced querying capabilities
+- **Bit.BlazorUI**: Primary UI framework 
+- **Microsoft.Extensions.AI**: AI integration
+- **TypeScript**: Type-safe JavaScript development 
+- **SCSS**: Advanced CSS preprocessing
+
+## Development Guidelines
+
+### Code Style & Conventions
+- **C# 13.0**: Use latest language features
+- **Nullable Reference Types**: Enabled project-wide
+- **Implicit Usings**: Leverage global using statements
+- **.editorconfig**: Use for consistent code style across IDEs
+
+### Global Using Statements
+The project uses extensive global using statements for common namespaces:
+
+### Building the Application
+Navigate to the server directory and run:
+```bash
+cd src/Server/Boilerplate.Server.Web
+dotnet build
+```
+
+### Running the Application
+To run the application, execute the following command in the server directory:
+```bash
+cd src/Server/Boilerplate.Server.Web
+dotnet run
+```
+
+### Testing the Application
+To run the tests, navigate to the test project directory and execute:
+```bash
+cd src/Tests
+dotnet test
+```
+
+### GitHub Codespaces Support
+The project is optimized for GitHub Codespaces development with pre-configured container support. 
+
+## Best Practices
+
+1. **Follow the established project structure**
+2. **Use Bit.BlazorUI components** - leverage the framework's built-in components and utilities
+3. **Follow nullable reference type conventions** - all new code should be nullable-aware
+4. **Use dependency injection** - leverage the built-in DI container for service registration
+5. **Implement proper logging** - use structured logging throughout the application
+6. **Follow security best practices** - use proper authentication and authorization patterns
+7. **Async Programming** - prefer async/await for I/O-bound operations, avoid blocking calls

src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.sln

@@ -37,9 +37,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 		.azure-devops\workflows\ci.yml = .azure-devops\workflows\ci.yml
 	EndProjectSection
 EndProject
-#elif (pipeline == "GitHub")
+#endif
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{3E577755-186F-4E63-8153-B8DE890015C9}"
+	ProjectSection(SolutionItems) = preProject
+		.github\copilot-instructions.md = .github\copilot-instructions.md
+	EndProjectSection
 EndProject
+#if (pipeline == "GitHub")
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{2347E3B2-FDDE-427E-A0AE-E4DCD47C2989}"
 	ProjectSection(SolutionItems) = preProject
 		.github\workflows\cd.yml = .github\workflows\cd.yml

src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx

@@ -22,8 +22,11 @@
     <File Path=".azure-devops/workflows/cd.yml" />
     <File Path=".azure-devops/workflows/ci.yml" />
   </Folder>
-//#elif (pipeline == "GitHub")
-  <Folder Name="/.SolutionItems/.github/" Id="351df30f-2daa-a858-be55-4affc8d70af2" />
+//#endif
+  <Folder Name="/.SolutionItems/.github/" Id="351df30f-2daa-a858-be55-4affc8d70af2">
+	<File Path=".github/copilot-instructions.md" />
+  </Folder>
+//#if (pipeline == "GitHub")
   <Folder Name="/.SolutionItems/.github/workflows/" Id="c0ca9c70-aac5-bd27-2f07-59fab982d30d">
     <File Path=".github/workflows/cd.yml" />
     <File Path=".github/workflows/ci.yml" />

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/Header/Header.razor.cs

@@ -22,7 +22,7 @@ protected override async Task OnInitAsync()
 
         unsubscribePageTitleChanged = PubSubService.Subscribe(ClientPubSubMessages.PAGE_DATA_CHANGED, async payload =>
         {
-            (pageTitle, pageSubtitle, showGoBackButton) = ((string?, string?,bool))payload!;
+            (pageTitle, pageSubtitle, showGoBackButton) = ((string?, string?, bool))payload!;
 
             StateHasChanged();
         });

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/StaticComponent.cs

@@ -1,10 +1,10 @@
-namespace Boilerplate.Client.Core.Components;
+namespace Boilerplate.Client.Core.Components;
 
 /// <summary>
 /// To prevent rendering recursion into a particular subtree use this component as base class.
 /// <see href="https://learn.microsoft.com/en-us/aspnet/core/blazor/performance?view=aspnetcore-9.0#avoid-unnecessary-rendering-of-component-subtrees"/>
 /// </summary>
-public class StaticComponent: ComponentBase
+public class StaticComponent : ComponentBase
 {
     protected override bool ShouldRender() => false;
 }

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/ProductEmbeddingService.cs

@@ -86,7 +86,7 @@ public async Task Embed(Product product, CancellationToken cancellationToken)
             return null;
         var embeddingGenerator = serviceProvider.GetService<IEmbeddingGenerator<string, Embedding<float>>>();
         if (embeddingGenerator is null)
-            return env.IsDevelopment() ? throw new InvalidOperationException("Embedding generator is not registered.") : null;
+            return env.IsDevelopment() ? null : throw new InvalidOperationException("Embedding generator is not registered.");
         var embedding = await embeddingGenerator.GenerateVectorAsync(input, options: new() { }, cancellationToken);
         return embedding.ToArray();
         //#endif

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/SignalR/AppHub.Chatbot.cs

@@ -93,7 +93,7 @@ async Task HandleIncomingMessage(string incomingMessage, CancellationToken messa
                                         .LogError("Chat reported issue: User email: {emailAddress}, Conversation history: {conversationHistory}", emailAddress, conversationHistory);
                                 }, name: "SaveUserEmailAndConversationHistory", description: "Saves the user's email address and the conversation history for future reference. Use this tool when the user provides their email address during the conversation. Parameters: emailAddress (string), conversationHistory (string)"),
                                 //#if (module == "Sales")
-                                AIFunctionFactory.Create(async ([Description("Concise summary of these user requirements in English Language")] string userNeeds, [Description("Car manufactor's English name (Optional)")] string? manufactor) =>
+                                AIFunctionFactory.Create(async ([Description("Concise summary of these user requirements in English Language")] string userNeeds, [Description("Car manufacturer's English name (Optional)")] string? manufacturer) =>
                                 {
                                     if (messageSpecificCancellationToken.IsCancellationRequested)
                                         return null;
@@ -102,14 +102,17 @@ async Task HandleIncomingMessage(string incomingMessage, CancellationToken messa
 
                                     await using var scope = serviceProvider.CreateAsyncScope();
                                     var productEmbeddingService = scope.ServiceProvider.GetRequiredService<ProductEmbeddingService>();
-                                    var recommendedProducts = await (await productEmbeddingService.GetProductsBySearchQuery($"{userNeeds}, Manufactor: {manufactor}", messageSpecificCancellationToken))
+                                    var searchQuery = string.IsNullOrWhiteSpace(manufacturer)
+                                        ? userNeeds
+                                        : $"{userNeeds}, Manufacturer: {manufacturer}";
+                                    var recommendedProducts = await (await productEmbeddingService.GetProductsBySearchQuery(searchQuery, messageSpecificCancellationToken))
                                         .Take(10)
                                         .Project()
                                         .Select(p => new
                                         {
                                             p.Name,
                                             PageUrl = new Uri(baseApiUrl, p.PageUrl),
-                                            Manufactor = p.CategoryName,
+                                            Manufacturer = p.CategoryName,
                                             Price = p.FormattedPrice,
                                             Description = p.DescriptionText
                                         })