-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Add copilot-instructions to repo #35812
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
|
@danroth27, @tdykstra, @guardrex, @IEvangelist: I could use your thoughts on this early draft for a copilot-instructions.md specific to this aspnetcore.docs repo. |
|
Given the length, it's best if I can look early next week. |
|
Do we know that all of this content adds value? I'd prefer to start small with things that we know Copilot needs additional context on and then we grow the content organically as we run into issues. Otherwise, how do we know we're not just wasting tokens? |
Slimmed down considerably removing details and duplications to writing guide.
Added back in a section that was truncated.
Added truncated last section back in.
Fixed truncating issue.
|
Thanks for the feedback: |
Added build warning handling
Added Markdown File Naming and Organization instruction, which is not found in the Style Guide, but important to call out.
API ref guessing issue instruction.
Thanks, It has been greatly reduced now already after feedback. haha. :) |
add metadata ai-usage: ai-assisted
Address breaking change feedback
Co-authored-by: Luke Latham <[email protected]>
Co-authored-by: Luke Latham <[email protected]>
Adding some great suggested changes from guardrex. Co-authored-by: Luke Latham <[email protected]>
Corrected link for metadata specific guide
Adding great suggestion from gewarren. Co-authored-by: Genevieve Warren <[email protected]>
Removed breaking change bullet as suggested by gewarren.
Removed vague Blazor specific instruction
BillWagner
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.
This LGTM.
|
@danroth27 and @tdykstra, I will go ahead and merge this copilot-instructions.md at the end of the day today unless I see any more ideas or requests for change. Approval from Gewarren, Bill and guardrex so far. Everyone had great feedback and ideas. |
tdykstra
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.
A Bit more to come but I'm Sending what I have now to get in under the EOD deadline
Co-authored-by: Tom Dykstra <[email protected]>
Co-authored-by: Tom Dykstra <[email protected]>
Fixes #35798
When we ask copilot to create a PR based on an issue, or to review a PR on this repo, copilot will use the instructions in this copilot-instructions.md to guide it and to facilitate workflow interaction with human authors or reviewers. The goal of the instructions is to help ensure Copilot's responses maintain consistent quality and follow established documentation standards and some minimal expected human Intractive workflow when assisting with ASP.NET Core documentation.
There isn't a way to preview or test the instructions locally before publishing them to the repository that I know of. This is because the instructions are processed by GitHub Copilot's systems when they're accessed from the repository. However, this copilot-intruction.md can be pointed to as a link in any GitHub Copilot session and then also point to an example issue or PR to see how it would react.
This was created based on the work of others for aspire and .net docs. (Thank you, David, Bill, Geneveive and Andy!):
https://github.com/dotnet/docs-aspire/blob/main/.github/copilot-instructions.md
https://github.com/dotnet/docs/blob/main/.github/copilot-instructions.md
I removed any duplication to the style guide and called out specifics needed for this aspnetcore.docs repo.
Also helpful:
https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=vscode
Internal previews