Add comprehensive GitHub Copilot instructions for WSL development#13352
Merged
Add comprehensive GitHub Copilot instructions for WSL development#13352
Conversation
Co-authored-by: benhillis <17727402+benhillis@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for WSL development
Aug 7, 2025
benhillis
reviewed
Aug 7, 2025
benhillis
reviewed
Aug 7, 2025
benhillis
reviewed
Aug 7, 2025
benhillis
reviewed
Aug 7, 2025
Member
|
@copilot - I have review comments. |
Co-authored-by: benhillis <17727402+benhillis@users.noreply.github.com>
Member
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
OneBlue
approved these changes
Aug 7, 2025
Collaborator
OneBlue
left a comment
There was a problem hiding this comment.
LGTM. Curious to see the impact it will have
benhillis
approved these changes
Aug 7, 2025
craigloewen-msft
approved these changes
Aug 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.