-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add comprehensive GitHub Copilot instructions for WSL development #13352
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: benhillis <[email protected]>
benhillis
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.
Minor comments.
|
@copilot - I have review comments. |
Co-authored-by: benhillis <[email protected]>
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
benhillis
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 - curious if @OneBlue has any thoughts.
OneBlue
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. Curious to see the impact it will have
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed guidance on how to work effectively in the WSL codebase.Key Features
Platform-Specific Guidance: The instructions clearly distinguish between what can be done on Windows vs Linux:
Exhaustively Validated Commands: Every command in the instructions has been tested and verified to work:
Precise Timing and Timeout Specifications:
Repository Navigation Guide: Detailed breakdown of key directories (
src/windows/,src/linux/,test/,doc/), important files (CMakeLists.txt,dev-loop.md), and frequently used commands for both Windows and cross-platform development.Validation Scenarios: Clear guidance on what to test after making changes, including manual validation requirements and pre-commit checklists that prevent CI failures.
The instructions start with the required directive to "ALWAYS reference these instructions first" and provide fallback guidance only when information is incomplete, following an imperative tone throughout ("Run [this command]", "Do not do [this]").
Fixes #13351.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.