Add Copilot instructions for HAVIT Blazor project template #10
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive Copilot instructions to help developers work effectively with this project template and projects derived from it.
What's Added
A new
.github/copilot-instructions.mdfile that provides:Project Architecture Overview: Clear explanation of the clean architecture pattern with all project layers (Web.Server, Web.Client, Model, Entity, DataLayer, Services, Facades, etc.)
Technology Stack Documentation: Complete coverage of .NET 9, Blazor Server/WebAssembly, Entity Framework Core 9, HAVIT Framework, Hangfire, and testing frameworks
Coding Guidelines: Naming conventions, Entity Framework patterns specific to HAVIT's repository pattern, business logic organization, and error handling best practices
Template Usage Guidelines: Step-by-step guidance for initial setup using
SetupSolution.ps1, code generation workflows, and configuration managementBest Practices: Performance optimization, security considerations, maintainability patterns, and migration strategies
Code Examples: Practical examples showing repository patterns, service registration, dependency injection, and Blazor component patterns
Troubleshooting: Common issues and solutions for build errors, migrations, DI registration, and component lifecycle management
Benefits
This enables Copilot to provide more accurate and contextually appropriate suggestions when working with:
The instructions are specifically tailored for this project template's architecture and will help maintain consistency across all projects derived from this template.
Fixes #9.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.