From 1c29067815827ac458ec72689f8045f734d441b5 Mon Sep 17 00:00:00 2001 From: Yeming Liu <11371776+isra-fel@users.noreply.github.com> Date: Wed, 12 Nov 2025 14:22:10 +1100 Subject: [PATCH] Create custom instructions for GH copilot to review ref docs --- .github/instructions/reference-doc.instructions.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .github/instructions/reference-doc.instructions.md diff --git a/.github/instructions/reference-doc.instructions.md b/.github/instructions/reference-doc.instructions.md new file mode 100644 index 000000000000..ba0b37d7d17e --- /dev/null +++ b/.github/instructions/reference-doc.instructions.md @@ -0,0 +1,9 @@ +--- +applyTo: "**/help/*.md" +--- + +## Reference help documentation requirements + +When writing reference documents for PowerShell cmdlets, please follow these guidelines to ensure readability and helpfulness: + +1. **Avoid over-simplified description** - For parameters and cmdlets, avoid over-simplified description such as "Some help", or simply repeating the parameter name.