Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 7, 2025

This PR adds a comprehensive .github/copilot-instructions.md file 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:

  • Windows: Full development with Visual Studio, CMake builds, MSI deployment, and TAEF testing
  • Linux: Documentation building, code formatting, validation scripts, and cross-platform development tasks

Exhaustively Validated Commands: Every command in the instructions has been tested and verified to work:

# Documentation build (0.5 seconds)
mkdocs build -f doc/mkdocs.yml

# Code formatting validation
clang-format --dry-run --style=file <files>

# Multi-threaded builds
cmake --build . -- -m

# Complete test suite
bin\x64\debug\test.bat

# Format all source files
powershell formatsource.ps1

Precise Timing and Timeout Specifications:

  • Windows builds: 20-45 minutes with 60+ minute timeout recommendations
  • Test suites: 30-60 minutes with 90+ minute timeout recommendations
  • Documentation builds: ~0.5 seconds with safety margins
  • All critical operations include "NEVER CANCEL" warnings

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.

Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for WSL development Aug 7, 2025
Copilot AI requested a review from benhillis August 7, 2025 01:14
Copy link
Member

@benhillis benhillis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments.

@benhillis
Copy link
Member

@copilot - I have review comments.

Copilot AI requested a review from benhillis August 7, 2025 17:09
@benhillis benhillis marked this pull request as ready for review August 7, 2025 17:10
@benhillis benhillis requested a review from a team as a code owner August 7, 2025 17:10
@benhillis
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Member

@benhillis benhillis left a 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.

Copy link
Collaborator

@OneBlue OneBlue left a 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

@benhillis benhillis enabled auto-merge (squash) August 7, 2025 21:10
@benhillis benhillis merged commit 3794ba3 into master Aug 7, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨Set up Copilot instructions

4 participants