Skip to content

Commit 11ae8b2

Browse files
benhillisBen HillisCopilot
authored
docs: overhaul Copilot instructions with coding conventions and prompt files (#40113)
* docs: overhaul Copilot instructions with coding conventions and prompt 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> * docs: address PR review feedback - 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> --------- Co-authored-by: Ben Hillis <benhill@ntdev.microsoft.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f9f1c38 commit 11ae8b2

File tree

5 files changed

+422
-101
lines changed

5 files changed

+422
-101
lines changed

.editorconfig

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# EditorConfig — https://editorconfig.org
2+
# Complements .clang-format for non-C++ files
3+
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 4
9+
end_of_line = crlf
10+
charset = utf-8
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
14+
[*.{cpp,h,hpp,c,idl}]
15+
# C/C++ formatting is handled by .clang-format
16+
indent_size = 4
17+
18+
[*.{yml,yaml}]
19+
indent_size = 2
20+
21+
[*.{json,jsonc}]
22+
indent_size = 2
23+
24+
[*.{md,markdown}]
25+
trim_trailing_whitespace = false
26+
27+
[*.py]
28+
indent_size = 4
29+
30+
[*.{ps1,psm1,psd1}]
31+
indent_size = 4
32+
33+
[*.{xml,resw,resx,props,targets,nuspec}]
34+
indent_size = 2
35+
36+
[*.cmake]
37+
indent_size = 4
38+
39+
[CMakeLists.txt]
40+
indent_size = 4
41+
42+
[Makefile]
43+
indent_style = tab

0 commit comments

Comments
 (0)