Skip to content

Commit bbe7bd7

Browse files
authored
Add copilot instructions (#3470)
1 parent f86c052 commit bbe7bd7

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/copilot-instructions.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# .NET Documentation Guidelines
2+
3+
## Disclosure
4+
5+
For any Markdown files generated by AI, always disclose that they were created with the assistance of AI. Add the following frontmatter key/value pair:
6+
7+
```markdown
8+
ai-usage: ai-generated
9+
```
10+
11+
## Terminology
12+
13+
Unless otherwise specified, all .NET content refers to modern .NET (not .NET Framework).
14+
15+
## Writing Style
16+
17+
Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) with these specifics:
18+
19+
### Voice and Tone
20+
21+
- Active voice, second person addressing reader directly.
22+
- Conversational tone with contractions.
23+
- Present tense for instructions/descriptions.
24+
- Imperative mood for instructions ("Call the method" not "You should call the method").
25+
- Use "might" instead of "may" for possibility.
26+
- Use "can" instead of "may" for permissible actions.
27+
- Avoid "we"/"our" referring to documentation authors or product teams.
28+
29+
### Structure and Format
30+
31+
- Sentence case headings (no gerunds in titles).
32+
- Be concise, break up long sentences.
33+
- Oxford comma in lists.
34+
- Use bullets for unordered lists.
35+
- Number all ordered list items as "1." (not sequential numbering like "1.", "2.", "3.", etc.)
36+
- Ordered and unordered lists should use complete sentences with proper punctuation, ending with a period if it's more than three words.
37+
- Avoid "etc." or "and so on" - provide complete lists or use "for example".
38+
- Use "for example" instead of "e.g.".
39+
- Use "that is" instead of "i.e.".
40+
- No consecutive headings without content between them.
41+
42+
### Formatting Conventions
43+
44+
- **Bold** for UI elements.
45+
- `Code style` for file names, folders, custom types, non-localizable text.
46+
- Raw URLs in angle brackets.
47+
- Use relative links for files in this repo.
48+
- Remove `https://learn.microsoft.com/en-us` from learn.microsoft.com links.
49+
50+
## File Naming
51+
52+
New Markdown files: lowercase with hyphens, omit filler words (the, a, etc.).
53+
54+
## Special Cases
55+
56+
- When you (Copilot) are assigned an issue in GitHub, after you've completed your work and the workflows (status checks) have run, check to make sure there are no build warnings under the OpenPublishing.Build status check. If there are, open the build report (under View Details) and resolve any build warnings you introduced.

0 commit comments

Comments
 (0)