Update copilot instructions #13586
Update copilot instructions #13586
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the solution to externalize Copilot instruction files into dedicated solution folders and adds detailed GDI+ guidance for WinForms renderers.
- Moves
.github/copilot-instructions.mdinto a new “Copilot” solution folder - Introduces a “Rendering” solution folder containing
GDIPlus-copilot-instructions.md - Adds comprehensive GDI+ best-practices documentation for performance, quality, and resource management
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| Winforms.sln | Added “Copilot” and “Rendering” solution folders; reorganized SolutionItems and configuration mappings |
| .github/copilot/GDIPlus-copilot-instructions.md | New file with 300+ lines of GDI+ usage guidelines and examples |
Comments suppressed due to low confidence (2)
.github/copilot/GDIPlus-copilot-instructions.md:17
- [nitpick] Consider rephrasing the header to remove the comma—e.g. “### APIs that already provide cached Pens or Brushes”—for improved readability.
### APIs, which already provide cached Pens or Brushes.
Winforms.sln:1207
- Solution folders don’t require project configuration mappings in the GlobalSection; this entry may be misconfigured or unnecessary and could be removed to avoid build warnings.
{D619FF8C-D99A-48AB-B16B-2F0E819B46D5} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #13586 +/- ##
====================================================
- Coverage 97.40051% 76.60143% -20.79909%
====================================================
Files 1181 3235 +2054
Lines 352685 639321 +286636
Branches 5368 47314 +41946
====================================================
+ Hits 343517 489729 +146212
- Misses 8412 146010 +137598
- Partials 756 3582 +2826
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
| ``` | ||
|
|
||
| Other examples for switch expressions are: |
There was a problem hiding this comment.
I've noticed that this "others" section doesn't have the markdown indicating csharp code, but most of the other example sections do. Just curious if that's intentional?
There was a problem hiding this comment.
Not relevant for the LLM, but for the color coding.
It's something which will most likely correct itself in the next iteration. But good catch!
|
|
||
| - **Prefer modern collection initializers**: Use `[]` syntax for collections | ||
|
|
There was a problem hiding this comment.
Here's we're back to indicating CSharp code, hence the question above. 😸
| - **Insert final newline at end of files** | ||
| - **Use 4-space indentation consistently** | ||
|
|
There was a problem hiding this comment.
Does bold instruct copilot that these are more important instructions?
There was a problem hiding this comment.
Since an LLM spilled this instruction out, it might!
This PR is adding a way more detailed instruction set according to our .editorConfig enforced coding-standards, and it helps with refactorings or code generation from Copilot to minimize manual work.
It also adds a set of rules for GDI/GDI+ based renderer instructions.
The latter does not get automatically involved. If you have a code file which you for example would like to review according to our standards, which are reflected by those instructions, prompt as an example something like this:
"Could you review the code file #MyNewGridViewRenderer.cs according to the GDI+ instructions in #GDIPlus-copilot-instructions.md"
Important: These instructions do NOT have any influence on how Copilot is reviewing PRs!
Note: If you wish the edit or expand on those instructions, please do not just read the instructions and interpret them as you would. If you think you need to improve them, please try your changes first with concrete example to make sure, what you want to change is actual an improvement.
I have tested and iterated on these instructions intensively.
They are a considerable improvement compared to what we had before.
Please try them and use them and consider adding additional ones for additional topics.
Microsoft Reviewers: Open in CodeFlow