Skip to content

Commit 1bab578

Browse files
authored
add copilot instructions (#11484)
1 parent e219a0b commit 1bab578

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

.github/copilot-instructions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Code comments should end with a period.
2+
3+
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.
4+
5+
Don't use the word "may". Use "might" to indicate possibility or "can" to indicate permission.
6+
7+
There should always be a comma before a clause that begins with "which".
8+
9+
Use a conversational tone with contractions.
10+
11+
Be concise.
12+
13+
Break up long sentences.
14+
15+
Use the present tense for instructions and descriptions. For example, "The method returns a value" instead of "The method will return a value."
16+
17+
Use the Oxford comma in lists of three or more items.

0 commit comments

Comments
 (0)