-
Notifications
You must be signed in to change notification settings - Fork 471
[Housekeeping] Add Co-Pilot Prompts #2576
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
[Housekeeping] Add Co-Pilot Prompts #2576
Conversation
pictos
left a comment
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.
It looks good, just need to fix some invalid chars and I've a couple of suggestions. I'll mark as Request Changes because of the invalid chars.
Resolved some suggestions.
Thanks Pedro. I think I have eliminated all of the invalid characters and also implemented all of the changes you suggested. |
|
@pictos @TheCodeTraveler @bijington @VladislavAntonyuk I had added a new prompt, specifically for MCT, that details some of the common code styles and implementation templates that we use. Please give them a try out. I personally appreciate the code reviews provided, but as this is NOT code that the end-user will be provided, please feel free to update this fork/branch as appropriate. The more the better. |
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.
Pull Request Overview
This PR adds several markdown documents that provide natural language guidelines on asynchronous programming, unit testing, memory leak prevention, MAUI controls, and general GitHub Copilot usage for the .NET MAUI Community Toolkit.
- Introduces coding guideline documents for asynchronous operations, unit testing with xUnit, and MAUI-specific practices.
- Provides detailed best practices for memory management, UI controls design, and overall code quality for MAUI projects.
- Adds GitHub Copilot instructions to help guide contributors on using Copilot effectively.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/prompts/dotnet/async.prompt.md | New async programming best practices guideline document |
| .github/prompts/dotnet/testing.xunit.prompt.md | New unit testing best practices guideline document using xUnit |
| .github/prompts/dotnet/maui/maui-memory-leaks.prompt.md | New guidelines for handling memory leaks in .NET MAUI applications |
| .github/prompts/dotnet/maui/maui-controls.prompt.md | New guidelines for page lifecycle and controls in .NET MAUI |
| .github/copilot-instructions.md | New documentation outlining GitHub Copilot usage and best practices |
| .github/prompts/prompts.prompt.md | New list of prompt instructions linking all the guideline documents |
Co-authored-by: Copilot <[email protected]>
pictos
left a comment
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.
LGTM, thanks for it @GeorgeLeithead
Description of Change
This PR adds natural language instructions for CoPilot to assist contributors with its automated code reviews and code completion suggestions and guidance.
More the the docs:
Linked Issues
PR Checklist
mainat time of PR