docs: overhaul Copilot instructions with coding conventions and prompt files#40113
Merged
docs: overhaul Copilot instructions with coding conventions and prompt files#40113
Conversation
…t files Major update to .github/copilot-instructions.md: - Add coding conventions (naming, error handling, RAII, strings, headers, synchronization, localization, telemetry, formatting, IDL/COM, config) - Add test authoring summary pointing to detailed test.md prompt - Add namespace-to-directory map for top-level namespaces - Add key source files list (defs.h, WslTelemetry.h, wslc.idl, etc.) - Replace clang-format references with .\FormatSource.ps1 - Consolidate duplicate timing info into single reference table New files: - .github/copilot/review.md: Review prompt focused on high-risk areas (ABI breaks, missing localization, resource safety) - .github/copilot/test.md: Test generation prompt with TAEF patterns - .github/copilot/commit.md: Commit message guidelines - .editorconfig: Editor settings for non-C++ files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
benhillis
requested review from
OneBlue,
Copilot,
craigloewen-msft,
damanm24 and
jstarks
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation update that refines the repository’s Copilot guidance so AI-assisted code generation/review better matches established WSL repo conventions (coding patterns, testing practices, and workflow commands).
Changes:
- Expands
.github/copilot-instructions.mdwith coding conventions (WIL/RAII, localization, telemetry, IDL/COM ABI rules), navigation pointers, and updated workflow/validation sections. - Adds scoped Copilot prompt files for review focus areas, test generation guidance, and commit message guidance.
- Introduces an
.editorconfigto standardize formatting defaults for non-C++ files.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Major expansion of repo-specific conventions and dev workflow guidance. |
.github/copilot/review.md |
New review prompt emphasizing ABI/resource safety/localization/telemetry risks. |
.github/copilot/test.md |
New TAEF-focused test generation guidelines and helper macro references. |
.github/copilot/commit.md |
New lightweight commit message guidelines. |
.editorconfig |
New formatting defaults intended to complement .clang-format for non-C++ files. |
- Scope precomp.h guidance to Windows components (Linux doesn't use it) - Fix review.md reference to .github/copilot-instructions.md - Restore clang-format as Linux formatting option alongside FormatSource.ps1 - Note FormatSource.ps1 requires cmake . first - Fix en-us -> en-US casing Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
OneBlue
approved these changes
Apr 6, 2026
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.
Summary of the Pull Request
Overhauls the Copilot instruction files so that AI-assisted code generation and review follows the actual conventions used in this repo.
PR Checklist
Detailed Description of the Pull Request / Additional comments
Updated .github/copilot-instructions.md:
New files:
Validation Steps Performed
Manual review of all conventions against actual codebase patterns.