Skip to content

Commit 1ae32fa

Browse files
committed
resolve merge conflict
2 parents 23d67d8 + 36487da commit 1ae32fa

File tree

4,196 files changed

+99221
-84974
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,196 files changed

+99221
-84974
lines changed

.devcontainer/devcontainer.json

Lines changed: 54 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,57 @@
11
{
22
"name": "C# (.NET)",
3-
"image": "mcr.microsoft.com/devcontainers/dotnet:latest"
4-
5-
// Features to add to the dev container. More info: https://containers.dev/features.
6-
// "features": {},
7-
8-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
9-
// "forwardPorts": [5000, 5001],
10-
// "portsAttributes": {
11-
// "5001": {
12-
// "protocol": "https"
13-
// }
14-
// }
15-
16-
// Use 'postCreateCommand' to run commands after the container is created.
17-
// "postCreateCommand": "dotnet restore",
18-
19-
// Configure tool-specific properties.
20-
// "customizations": {},
3+
"image": "mcr.microsoft.com/devcontainers/dotnet:latest",
4+
"customizations": {
5+
"vscode": {
6+
"settings": {
7+
"githubIssues.queries": [
8+
{
9+
"label": "My dotnet/docs Issues",
10+
"query": "is:open assignee:${user} repo:dotnet/docs"
11+
},
12+
{
13+
"label": "My seQUESTered dotnet/docs Issues",
14+
"query": "is:open assignee:${user} repo:dotnet/docs sort:updated-desc -label:needs-more-info label:\":pushpin: seQUESTered\""
15+
},
16+
{
17+
"label": "Created dotnet/docs Issues",
18+
"query": "author:${user} state:open repo:dotnet/docs sort:created-desc"
19+
},
20+
{
21+
"label": "Recent Issues",
22+
"query": "state:open repo:dotnet/docs sort:updated-desc"
23+
}
24+
],
25+
"githubPullRequests.queries": [
26+
{
27+
"label": "Waiting for dotnet/docs Review",
28+
"query": "repo:dotnet/docs is:open team-review-requested:dotnet/docs"
29+
},
30+
{
31+
"label": "Waiting For Just My Review (dotnet/docs)",
32+
"query": "repo:dotnet/docs is:open review-requested:${user} -team-review-requested:dotnet/docs"
33+
},
34+
{
35+
"label": "Assigned To Me (dotnet/docs)",
36+
"query": "repo:dotnet/docs is:open assignee:${user}"
37+
},
38+
{
39+
"label": "Created By Me (dotnet/docs)",
40+
"query": "repo:dotnet/docs is:open author:${user}"
41+
}
42+
]
43+
},
44+
"extensions": [
45+
"Acrolinx.vscode-sidebar",
46+
"DotJoshJohnson.xml",
47+
"GitHub.copilot",
48+
"GitHub.copilot-chat",
49+
"GitHub.vscode-pull-request-github",
50+
"IEvangelist.xref-helper",
51+
"docsmsft.docs-authoring-pack",
52+
"ms-dotnettools.csdevkit",
53+
"ms-dotnettools.csharp"
54+
]
55+
}
56+
}
2157
}

.github/CODEOWNERS

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@
2121
# This should make it easy to add new rules without breaking existing ones.
2222

2323
######## API landing page ###########
24-
/api/ @dotnet/docs
24+
/api/ @gewarren @dotnet/docs
25+
26+
######## Includes files ###########
27+
/includes/ @dotnet/docs
2528

2629
############ What's new ###############
2730
/docs/whats-new/ @billwagner @dotnet/docs
@@ -30,6 +33,9 @@
3033
# .NET Core
3134
/docs/core/ @dotnet/docs
3235

36+
# .NET fundamentals
37+
/docs/fundamentals/ @dotnet/docs
38+
3339
# .NET Framework
3440
/docs/framework/ @dotnet/docs
3541

@@ -40,82 +46,85 @@
4046
/docs/csharp/ @BillWagner @dotnet/docs
4147

4248
# The F# Guide:
43-
/docs/fsharp/ @BillWagner @kathleendollard @dotnet/fsharp-team-msft @dotnet/docs
49+
/docs/fsharp/ @BillWagner @dotnet/fsharp-team-msft @dotnet/docs
4450

4551
# The Visual Basic Guide:
46-
/docs/visual-basic/ @KathleenDollard @BillWagner @dotnet/docs
52+
/docs/visual-basic/ @BillWagner @dotnet/docs
4753

4854
# The ML.NET Guide:
49-
/docs/machine-learning/ @gewarren @luisquintanilla @JakeRadMSFT @michaelgsharp @dotnet/docs
55+
/docs/machine-learning/ @gewarren @luisquintanilla @JakeRadMSFT @dotnet/docs
5056

5157
# The .NET Architecture Guide:
5258
/docs/architecture/ @nishanil @IEvangelist @dotnet/docs
5359

5460
# .NET Orleans
5561
/docs/orleans/ @IEvangelist @dotnet/docs
5662

63+
# IoT Guide
64+
/docs/iot/ @dotnet/docs
65+
66+
############### AI ################
67+
68+
/docs/ai/ @gewarren @dotnet/docs
69+
5770
############### Azure ################
5871

5972
# Azure Guide
60-
/docs/azure/ @alexwolfmsft @CamSoper @dotnet/docs
73+
/docs/azure/ @alexwolfmsft @dotnet/docs
6174

6275
# Azure SDK package list
6376
/docs/azure/includes/ @dotnet/docs
6477

6578
# Azure SDK catch-all entry
66-
/docs/azure/sdk/ @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
79+
/docs/azure/sdk/ @jsquire @alexwolfmsft @scottaddie @dotnet/docs
6780

6881
# Azure SDK authentication topics
69-
/docs/azure/sdk/authentication/ @christothes @schaabs @dotnet/docs @alexwolfmsft @CamSoper @scottaddie
82+
/docs/azure/sdk/authentication/ @JonathanCrd @christothes @dotnet/docs @alexwolfmsft @scottaddie
7083

7184
# Azure SDK miscellaneous topics
72-
/docs/azure/sdk/azure-sdk-configure-proxy.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
73-
/docs/azure/sdk/azure-sdk-for-net.md @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
74-
/docs/azure/sdk/dependency-injection.md @JoshLove-msft @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
75-
/docs/azure/sdk/logging.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
76-
/docs/azure/sdk/packages.md @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
77-
/docs/azure/sdk/pagination.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
78-
/docs/azure/sdk/protocol-convenience-methods.md @annelo-msft @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
79-
/docs/azure/sdk/resource-management.md @ArthurMa1978 @m-nash @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
80-
/docs/azure/sdk/thread-safety.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
81-
/docs/azure/sdk/unit-testing-mocking.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @CamSoper @scottaddie @dotnet/docs
82-
83-
# IoT Guide
84-
/docs/iot/ @CamSoper @dotnet/docs
85-
86-
# Includes files
87-
/includes/ @dotnet/docs
88-
89-
############### .NET 5 ################
85+
/docs/azure/sdk/azure-sdk-configure-proxy.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @scottaddie @dotnet/docs
86+
/docs/azure/sdk/azure-sdk-for-net.md @jsquire @alexwolfmsft @scottaddie @dotnet/docs
87+
/docs/azure/sdk/dependency-injection.md @JoshLove-msft @jsquire @alexwolfmsft @scottaddie @dotnet/docs
88+
/docs/azure/sdk/logging.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft
89+
/docs/azure/sdk/packages.md @jsquire @alexwolfmsft @scottaddie @dotnet/docs
90+
/docs/azure/sdk/pagination.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @scottaddie @dotnet/docs
91+
/docs/azure/sdk/protocol-convenience-methods.md @annelo-msft @jsquire @alexwolfmsft @scottaddie @dotnet/docs
92+
/docs/azure/sdk/resource-management.md @ArthurMa1978 @m-nash @alexwolfmsft @scottaddie @dotnet/docs
93+
/docs/azure/sdk/thread-safety.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @scottaddie @dotnet/docs
94+
/docs/azure/sdk/unit-testing-mocking.md @annelo-msft @christothes @JoshLove-msft @KrzysztofCwalina @jsquire @alexwolfmsft @scottaddie @dotnet/docs
95+
96+
############### Fundamentals ################
9097

9198
# Code analysis
9299
/docs/fundamentals/code-analysis/ @gewarren @dotnet/docs
93100

94101
############### .NET Core ########################
95-
# What's New
96-
/docs/core/whats-new/ @camsoper @dotnet/docs
102+
# Breaking changes
103+
/docs/core/compatibility/ @gewarren @dotnet/docs
104+
# Containers
105+
/docs/core/containers/ @dotnet/docs
97106
# Deployment
98107
/docs/core/deploying/ @adegeo @dotnet/docs
99108
# Diagnostics
100109
/docs/core/diagnostics/ @tommcdon @dotnet/docs
101-
# Extensions
102-
/docs/core/extensions/ @IEvangelist @dotnet/docs
103110
# Docker
104111
/docs/core/docker/ @IEvangelist @dotnet/docs
112+
# Extensions
113+
/docs/core/extensions/ @IEvangelist @dotnet/docs
105114
# Install
106115
/docs/core/install/ @adegeo @dotnet/docs
107-
# Breaking changes
108-
/docs/core/compatibility/ @camsoper @dotnet/docs
109116
# Project SDKs
110117
/docs/core/project-sdk/ @gewarren @dotnet/docs
111118
# Config settings
112119
/docs/core/runtime-config/ @gewarren @dotnet/docs
113120
# Testing
114121
/docs/core/testing/ @IEvangelist @dotnet/docs
115122
# Tools
116-
/docs/core/tools/ @tdykstra @dotnet/docs
123+
/docs/core/tools/ @adegeo @dotnet/docs
117124
# Tutorials
118-
/docs/core/tutorials/ @tdykstra @dotnet/docs
125+
/docs/core/tutorials/ @meaghanlewis @dotnet/docs
126+
# What's new
127+
/docs/core/whats-new/ @dotnet/docs
119128

120129
################### .NET Framework ##################
121130
# App domains
@@ -150,8 +159,8 @@
150159
/docs/framework/configure-apps/file-schema/network/ @karelz @dotnet/docs
151160
/docs/framework/network-programming/ @karelz @dotnet/docs
152161
# WCF
153-
/docs/framework/configure-apps/file-schema/wcf/ @HongGit @dotnet/docs
154-
/docs/framework/wcf/ @HongGit @dotnet/docs
162+
/docs/framework/configure-apps/file-schema/wcf/ @dotnet/docs
163+
/docs/framework/wcf/ @dotnet/docs
155164

156165
################## .NET Standard ##################
157166
# Analyzers
@@ -170,7 +179,7 @@
170179
# Collections
171180
/docs/standard/collections/ @IEvangelist @dotnet/docs
172181
# System.CommandLine
173-
/docs/standard/commandline/ @tdykstra @dotnet/docs
182+
/docs/standard/commandline/ @gewarren @dotnet/docs
174183
# Data
175184
/docs/standard/data/ @gewarren @dotnet/docs
176185
# Data - SQLite
@@ -216,12 +225,13 @@
216225
# gRPC:
217226
/docs/architecture/grpc-for-wcf-developers/ @IEvangelist @dotnet/docs
218227
# Desktop:
219-
/docs/architecture/modernize-desktop/ @OliaG @IEvangelist @dotnet/docs
228+
/docs/architecture/modernize-desktop/ @IEvangelist @dotnet/docs
220229

221230
################# Samples folder ##############
222231

223232
## These have been pulled directly from the samples repo:
224233

234+
# C# snippets:
225235
/samples/snippets/csharp/ @BillWagner @IEvangelist @dotnet/docs
226236
# Visual Basic snippets:
227237
/samples/snippets/visualbasic/ @BillWagner @dotnet/docs

.github/ISSUE_TEMPLATE/02-breaking-change.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels:
66
- Pri1
77
- doc-idea
88
assignees:
9-
- camsoper
9+
- gewarren
1010
body:
1111
- type: textarea
1212
id: description
@@ -23,12 +23,15 @@ body:
2323
options:
2424
- .NET 8
2525
- .NET 9
26-
- .NET 10 Preview 1
27-
- .NET 10 Preview 2
28-
- .NET 10 Preview 3
2926
- .NET 10 Preview 4
3027
- .NET 10 Preview 5
3128
- .NET 10 Preview 6
29+
- .NET 10 Preview 7
30+
- .NET 10 RC 1
31+
- .NET 10 RC 2
32+
- .NET 10 GA
33+
- .NET 11 Preview 1
34+
- .NEt 11 Preview 2
3235
- Other (please put exact version in description textbox)
3336
validations:
3437
required: true

.github/copilot-instructions.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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+
## API References
51+
52+
Use cross-references: `<xref:api-doc-ID>`.
53+
54+
To find API doc IDs:
55+
1. Check XML files in https://github.com/dotnet/dotnet-api-docs.
56+
2. For types: `Value` attribute of `<TypeSignature>` where `Language="DocId"` (omit first 2 characters).
57+
3. For members: `Value` attribute of `<MemberSignature>` where `Language="DocId"` (omit first 2 characters).
58+
59+
If unsure, use API browser: `https://learn.microsoft.com/api/apibrowser/dotnet/search?api-version=0.2&locale=en-us&search={API_NAME}&$skip=0&$top=5` and then use the `url` value from the results as a manual link.
60+
61+
## Code Snippets
62+
63+
For snippets >6 lines:
64+
1. Create `./snippets/my-doc/language` folder in same directory as document (for a document named `my-doc.md`) where language is either vb (for visual basic) or csharp (for c#). Omit the `language` component when the document is in the `docs/visual-basic`, `docs/csharp`, or `docs/fsharp` folders.
65+
1. Add snippet as separate code file.
66+
1. Include simple project file targeting latest .NET.
67+
1. All code should use the latest stable versions/features.
68+
1. Create examples in both C# and Visual Basic unless the article referencing the snippet resides in the in the `csharp`, `fsharp`, and `visual-basic` language folders.
69+
1. When you add code, use code comments sparingly because they don't get localized. You can use them to briefly clarify code-specific details (such as logic, parameters, or edge cases). Put any critical information and context in the markdown text of the referencing article.
70+
71+
## File Naming
72+
73+
New Markdown files: lowercase with hyphens, omit filler words (the, a, etc.).
74+
75+
## Special Cases
76+
77+
- Breaking changes: Include directions from `.github/prompts/breaking-change.md`.
78+
- 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)