-
Notifications
You must be signed in to change notification settings - Fork 2
Add comprehensive GitHub Copilot instructions following ASP.NET Core best practices #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
…ands and scenarios Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
|
@copilot you have to remove all files you created except md one, next I see a lot of irrelevant text and instruction. About tests, benchmarks and random stuff |
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Done! I've removed all the extra files (dotnet-install.sh, test results) and simplified the copilot-instructions.md by removing the verbose testing scenarios, benchmark instructions, and detailed troubleshooting sections. The file now focuses on essential build commands, project structure, and core Result type concepts. (commit 23611d2) |
|
@copilot you did totally wrong. Remove all this dotnet installation stuff p. No pep me need it. But return important information about project |
…t information Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Removed all dotnet installation instructions and focused on important project information including core Result types, railway-oriented programming concepts, and project structure. (commit 71a0936) |
|
@copilot this is not enough, where are best practices? All this stuff from recommendation you read about? Code style? Copilot instructions? |
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Enhanced copilot-instructions.md with comprehensive best practices, code style guidelines, and Copilot-specific instructions including: • Code style & conventions from .editorconfig (.NET 9.0, 4 spaces, braces on new lines, var usage, naming conventions) The file now provides exactly what GitHub Copilot needs to understand the project architecture and coding conventions. (commit 4f4f21a) |
|
@copilot this is better, but still not ideal, can you check https://github.com/dotnet/aspnetcore/blob/main/.github/copilot-instructions.md this? Maybe we can improve ours? Also search in internet bet practices for this copilot-instructions.md ? |
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Improved the copilot-instructions.md by following the ASP.NET Core repository structure and best practices. The file is now more concise and actionable, with: • General guidelines section with high-level guidance The structure now follows proven patterns from successful open-source projects while maintaining focus on the Result pattern architecture. (commit f7c2b5e) |
.github/copilot-instructions.md
Outdated
|
|
||
| ```bash | ||
| # Requires .NET 9.0 SDK | ||
| dotnet build ManagedCode.Communication.Tests/Tests.ManagedCode.Communication.sln |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dotnet build and dotnet test and this is all @copilot
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Simplified the build commands to just dotnet build and dotnet test as requested, removing the SDK requirements comment and specific solution file paths.
|
@copilot revieew this file one more time, you can do much better and check project to be consistent |
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
I've reviewed and improved the copilot-instructions.md file to be more consistent with the project: • Removed SDK installation details (following ASP.NET Core pattern) The file now follows proven patterns from successful open-source projects while staying focused on the Result pattern architecture. (commit 4d0c5d3) |
|
@copilot check code one mor time result.IsSuccess.Should().BeTrue(); |
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Fixed the test example to match the actual project code style. The FluentAssertions are now written in the multi-line format consistent with the actual test files in the repository. (commit 27b5e0e) |
This PR adds a comprehensive
.github/copilot-instructions.mdfile that follows the proven structure and best practices from the ASP.NET Core repository, providing GitHub Copilot coding agents with essential guidance for working effectively in the ManagedCode.Communication repository.Key Features
Follows ASP.NET Core Structure
dotnet buildanddotnet test.editorconfiginstead of duplicating contentTesting and Development Integration
Method_Scenario_ExpectedResult()Result Pattern Focus
The instructions are actionable and concise while maintaining comprehensive coverage of the project's unique Result pattern architecture and development workflow.
Fixes #42.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.