You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+1-23Lines changed: 1 addition & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,15 @@
1
1
---
2
2
author: wadepickett
3
3
ms.author: wpickett
4
-
ms.date: 07-28-2025
4
+
ms.date: 07-29-2025
5
5
---
6
6
7
7
# Copilot Instructions for `dotnet/AspNetCore.Docs`
8
8
9
9
## Introduction
10
-
11
10
This document contains repository-specific instructions for GitHub Copilot when assisting with the `dotnet/AspNetCore.Docs` repository. **Unless otherwise specified, all ".NET" references refer to modern .NET, not .NET Framework.**
12
11
13
12
## Repository-Specific Guidelines
14
-
15
13
- Follow the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
16
14
-**Repository Exceptions**:
17
15
- Number ordered lists as "1." for every item (don't use sequential numbers)
@@ -25,46 +23,28 @@ This document contains repository-specific instructions for GitHub Copilot when
25
23
26
24
## Version Targeting
27
25
28
-
### Detection Priority Order
29
-
1.**Explicit PR/Issue Instructions** - Prioritize explicit version ranges mentioned
30
-
2.**File Metadata** - Check YAML frontmatter for specifications
31
-
3.**Inline Moniker Tags** - Look for version range specifications
32
-
4.**Repository Branch Context** - Consider branch where PR will be merged
33
-
5.**Directory Structure** - Check for version-specific directories
- Never guess API documentation IDs, always verify. If unable to verfy, say so.
44
34
- Check if features were introduced after .NET Core 3.1
45
35
- Default to most compatible syntax when uncertain
46
-
- For breaking changes, check:
47
-
- Changes to default behavior of existing APIs
48
-
- Removed or renamed public API elements
49
-
- Modified method signatures or return types
50
-
- Changed serialization formats
51
-
- Altered dependency requirements
52
-
- Changes to configuration schema
53
36
54
37
## Links and References
55
-
56
38
- Use relative links for files within this repo
57
39
- When adding external links into a document, strip out the language/culture segment of the URL if present (example: remove the `en-us` or `en` part of links to English versions of webpages)
58
40
- For learn.microsoft.com links, remove `https://learn.microsoft.com/en-us` from URLs
59
41
- Use cross-references for APIs: `<xref:api-doc-ID>`
60
42
- Get doc ID from the relevant XML doc in dotnet-api-docs, and omit the first two characters of the doc ID
61
43
62
44
## Markdown File Naming and Organization
63
-
64
45
- If you're adding a new Markdown file, it should be named in all lowercase with hyphens separating words. Also, omit any filler words such as "the" or "a" from the file name.
65
46
66
47
## Code Snippets
67
-
68
48
- For snippets **longer than 6 lines**:
69
49
- Place in separate `.cs` file in a `snippets` folder next to the Markdown file
70
50
- Create a subfolder named after the document
@@ -101,7 +81,6 @@ Console | console | 2
101
81
Text | - | 2
102
82
103
83
## ASP.NET Core Specific Guidelines
104
-
105
84
- Use the latest supported version for examples unless otherwise specified
106
85
- Title and section header casing is sentence case (capitalize the first word and any proper nouns)
107
86
- For parts of a title or section header that normally use code style in article text (backticks around the content), also use code style in the title or section header (example H1 header: "# Modify the `Program.cs` file")
@@ -113,7 +92,6 @@ Text | - | 2
113
92
- For middleware content and examples, use the middleware class approach
114
93
115
94
## Issue Handling
116
-
117
95
When creating a PR for an issue:
118
96
1. Read the full issue and all linked references
119
97
2. Study code samples from linked PRs for pre-release features
0 commit comments