Skip to content

Commit 812fc78

Browse files
committed
More suggestion added and clean up.
1 parent 089f5b7 commit 812fc78

File tree

1 file changed

+1
-23
lines changed

1 file changed

+1
-23
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
---
22
author: wadepickett
33
ms.author: wpickett
4-
ms.date: 07-28-2025
4+
ms.date: 07-29-2025
55
---
66

77
# Copilot Instructions for `dotnet/AspNetCore.Docs`
88

99
## Introduction
10-
1110
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.**
1211

1312
## Repository-Specific Guidelines
14-
1513
- Follow the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
1614
- **Repository Exceptions**:
1715
- 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
2523

2624
## Version Targeting
2725

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
34-
3526
### Common Range Patterns
3627
- Fixed Range: `>= aspnetcore-7.0 <= aspnetcore-9.0`
3728
- Open Upper Bound: `>= aspnetcore-7.0`
3829
- Open Lower Bound: `<= aspnetcore-9.0`
3930
- Specific Version: `== aspnetcore-9.0`
4031

4132
## API References and Verification
42-
4333
- Never guess API documentation IDs, always verify. If unable to verfy, say so.
4434
- Check if features were introduced after .NET Core 3.1
4535
- 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
5336

5437
## Links and References
55-
5638
- Use relative links for files within this repo
5739
- 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)
5840
- For learn.microsoft.com links, remove `https://learn.microsoft.com/en-us` from URLs
5941
- Use cross-references for APIs: `<xref:api-doc-ID>`
6042
- Get doc ID from the relevant XML doc in dotnet-api-docs, and omit the first two characters of the doc ID
6143

6244
## Markdown File Naming and Organization
63-
6445
- 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.
6546

6647
## Code Snippets
67-
6848
- For snippets **longer than 6 lines**:
6949
- Place in separate `.cs` file in a `snippets` folder next to the Markdown file
7050
- Create a subfolder named after the document
@@ -101,7 +81,6 @@ Console | console | 2
10181
Text | - | 2
10282
10383
## ASP.NET Core Specific Guidelines
104-
10584
- Use the latest supported version for examples unless otherwise specified
10685
- Title and section header casing is sentence case (capitalize the first word and any proper nouns)
10786
- 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
11392
- For middleware content and examples, use the middleware class approach
11493
11594
## Issue Handling
116-
11795
When creating a PR for an issue:
11896
1. Read the full issue and all linked references
11997
2. Study code samples from linked PRs for pre-release features

0 commit comments

Comments
 (0)