mirror of
https://github.com/github/awesome-copilot.git
synced 2026-07-14 01:51:02 +00:00
Komal Vardhan Lolugu
0fa87ab383
* Refresh 6 stale instruction files flagged in #2133 Targeted refresh: - blazor: C# 13 to C# 14. Drop the Visual Studio Enterprise mandate so contributors on VS Code or Rider aren't blocked by a paid SKU. Swap VS-only profiling for dotnet-trace and dotnet-counters. - copilot-thought-logging: narrow applyTo from '**' to '**/Copilot-Processing.md'. Replace 9 Windows backslash paths with POSIX './Copilot-Processing.md' so the workflow works on macOS and Linux. - genaiscript: drop the "avoid exception handlers or error checking" line. Replace it with: handle errors at I/O and external API boundaries, let unexpected exceptions surface. - memory-bank: add the required 'description' frontmatter field (was a validation failure). Narrow applyTo from '**' to 'memory-bank/**'. Add an opt-in note so contributors know auxiliary files land in the workspace root. Minor modernization: - azure-functions-typescript: Node.js v20 to v22 LTS. - localization: relative '../../issues' disclaimer link to absolute https://github.com/github/awesome-copilot/issues so it resolves regardless of the localized doc's path. docs/README.instructions.md regenerated by 'npm run build' to pick up the new memory-bank description. * revert applyTo narrow on copilot-thought-logging (#2133 review) aaronpowell flagged that narrowing applyTo from '**' to '**/Copilot-Processing.md' inverts the instruction. The instruction tells Copilot to CREATE Copilot-Processing.md when handling any user request, so it must apply globally, not only when that file is already open. Restore applyTo to '**'. Keep the POSIX path fixes (backslash to './Copilot-Processing.md') and the other 5 file fixes in this PR unchanged. --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
78 lines
4.4 KiB
Markdown
78 lines
4.4 KiB
Markdown
---
|
|
description: 'Blazor component and application patterns'
|
|
applyTo: '**/*.razor, **/*.razor.cs, **/*.razor.css'
|
|
---
|
|
|
|
## Blazor Code Style and Structure
|
|
|
|
- Write idiomatic and efficient Blazor and C# code.
|
|
- Follow .NET and Blazor conventions.
|
|
- Use Razor Components appropriately for component-based UI development.
|
|
- 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.
|
|
|
|
## Naming Conventions
|
|
|
|
- Follow PascalCase for component names, method names, and public members.
|
|
- Use camelCase for private fields and local variables.
|
|
- Prefix interface names with "I" (e.g., IUserService).
|
|
|
|
## Blazor and .NET Specific Guidelines
|
|
|
|
- Utilize Blazor's built-in features for component lifecycle (e.g., OnInitializedAsync, OnParametersSetAsync).
|
|
- Use data binding effectively with @bind.
|
|
- Leverage Dependency Injection for services in Blazor.
|
|
- Structure Blazor components and services following Separation of Concerns.
|
|
- Always use the latest version C#, currently C# 14 features like record types, pattern matching, and global usings.
|
|
|
|
## Error Handling and Validation
|
|
|
|
- Implement proper error handling for Blazor pages and API calls.
|
|
- Use logging for error tracking in the backend and consider capturing UI-level errors in Blazor with tools like ErrorBoundary.
|
|
- Implement validation using FluentValidation or DataAnnotations in forms.
|
|
|
|
## Blazor API and Performance Optimization
|
|
|
|
- Utilize Blazor server-side or WebAssembly optimally based on the project requirements.
|
|
- Use asynchronous methods (async/await) for API calls or UI actions that could block the main thread.
|
|
- Optimize Razor components by reducing unnecessary renders and using StateHasChanged() efficiently.
|
|
- Minimize the component render tree by avoiding re-renders unless necessary, using ShouldRender() where appropriate.
|
|
- Use EventCallbacks for handling user interactions efficiently, passing only minimal data when triggering events.
|
|
|
|
## Caching Strategies
|
|
|
|
- Implement in-memory caching for frequently used data, especially for Blazor Server apps. Use IMemoryCache for lightweight caching solutions.
|
|
- For Blazor WebAssembly, utilize localStorage or sessionStorage to cache application state between user sessions.
|
|
- Consider Distributed Cache strategies (like Redis or SQL Server Cache) for larger applications that need shared state across multiple users or clients.
|
|
- Cache API calls by storing responses to avoid redundant calls when data is unlikely to change, thus improving the user experience.
|
|
|
|
## State Management Libraries
|
|
|
|
- Use Blazor's built-in Cascading Parameters and EventCallbacks for basic state sharing across components.
|
|
- Implement advanced state management solutions using libraries like Fluxor or BlazorState when the application grows in complexity.
|
|
- For client-side state persistence in Blazor WebAssembly, consider using Blazored.LocalStorage or Blazored.SessionStorage to maintain state between page reloads.
|
|
- For server-side Blazor, use Scoped Services and the StateContainer pattern to manage state within user sessions while minimizing re-renders.
|
|
|
|
## API Design and Integration
|
|
|
|
- Use HttpClient or other appropriate services to communicate with external APIs or your own backend.
|
|
- Implement error handling for API calls using try-catch and provide proper user feedback in the UI.
|
|
|
|
## Testing and Debugging
|
|
|
|
- All unit testing and integration testing should run cross-IDE (Visual Studio, VS Code, JetBrains Rider) so contributors aren't gated on a paid SKU.
|
|
- Test Blazor components and services using xUnit, NUnit, or MSTest.
|
|
- Use Moq or NSubstitute for mocking dependencies during tests.
|
|
- Debug Blazor UI issues using browser developer tools, and use your IDE's debugger for backend and server-side issues.
|
|
- For performance profiling and optimization, use your IDE's diagnostics tools or `dotnet-trace` / `dotnet-counters` for cross-platform profiling.
|
|
|
|
## Security and Authentication
|
|
|
|
- Implement Authentication and Authorization in the Blazor app where necessary using ASP.NET Identity or JWT tokens for API authentication.
|
|
- Use HTTPS for all web communication and ensure proper CORS policies are implemented.
|
|
|
|
## API Documentation and Swagger
|
|
|
|
- Use Swagger/OpenAPI for API documentation for your backend API services.
|
|
- Ensure XML documentation for models and API methods for enhancing Swagger documentation.
|