-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Refactor copilot instructions to include specific issue link for Fact… #47281
Conversation
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.
PR Overview
This PR refactors the copilot instructions to clarify guidelines for code style, testing, and output considerations, with a specific addition addressing the Fact attribute's Skip parameter for linking issues.
- Introduces separate sections for Coding Style and Changes, Testing, and Output Considerations.
- Adds a guideline for using the Fact attribute’s Skip parameter to point to a specific issue link.
Reviewed Changes
File | Description |
---|---|
.github/copilot-instructions.md | Reformatted sections and added instructions for issue linking with the Fact Skip parameter |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
- The Skip parameter of the Fact attribute to point to the specific issue link. | ||
|
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.
[nitpick] The instruction for the 'Skip' parameter should provide explicit guidance on formatting the issue link or reference. Consider specifying the expected URL format or including an example to improve clarity.
- The Skip parameter of the Fact attribute to point to the specific issue link. | |
- The Skip parameter of the Fact attribute should point to the specific issue link. Use the format `https://github.com/owner/repo/issues/issue_number`. For example: `https://github.com/example/repo/issues/123`. |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
||
When considering how output should look, solicit advice from baronfel. | ||
Output Considerations: | ||
- When considering how output should look, solicit advice from baronfel. |
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.
If we are already updating this, I might suggest
- When considering how output should look, solicit advice from baronfel. | |
- When considering how output should look, solicit advice from baronfel. | |
Localization: | |
- Avoid modifying .xlf files and instead prompt the user to update them using the `/t:UpdateXlf` target on MSBuild. | |
- Consider localizing strings in .resx files when possible |
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.
Thanks for your feedback! I've added the localization instructions based on your suggestions.
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.
How is Copilot going to know whether the user edited .xlf files manually or ran dotnet msbuild -t:UpdateXlf
?
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.
I thought it more as copilot not making any suggestions to update the xlf files
… attribute
The result of verifying the new addition rule looks good
