From 6e570871240bdae640e73cd9f68a7ddcec38c8c9 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 19 Jun 2025 11:30:43 +0200 Subject: [PATCH] add copilot instructions --- .github/copilot-instructions.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000000..683b79f69d9 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,17 @@ +Code comments should end with a period. + +When you add a code snippet to the XML remarks of an API, add the code as a separate code file (.cs file) and not as an inline (```) code block. Also add a .csproj file to compile the code if one doesn't already exist in the snippet folder. + +Don't use the word "may". Use "might" to indicate possibility or "can" to indicate permission. + +There should always be a comma before a clause that begins with "which". + +Use a conversational tone with contractions. + +Be concise. + +Break up long sentences. + +Use the present tense for instructions and descriptions. For example, "The method returns a value" instead of "The method will return a value." + +Use the Oxford comma in lists of three or more items.