Skip to content

Commit 6fe61d2

Browse files
committed
Merge remote-tracking branch 'upstream/main' into user_events_functional_runtime_test
2 parents 5103de3 + 06d89d2 commit 6fe61d2

File tree

3,375 files changed

+33813
-23615
lines changed

Some content is hidden

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

3,375 files changed

+33813
-23615
lines changed

.CodeQL.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ path_classifiers:
88
# be excluded from analysis. If there is a problem at the API layer, the analysis
99
# engine will detect the problem in the src/ implementations anyway.
1010
- src/libraries/**/ref/*
11+
cmake_internal:
1112
# exclude artifacts/obj/**/CMakeFiles/**/CheckFunctionExists.c since CMake
1213
# generates random directory names causing creation of duplicate issues
1314
# related to obsolete encryption algorithm used. Note that CheckFuntionExists

.azuredevops/dependabot.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
version: 2
2+
3+
# Disabling dependabot on Azure DevOps as this is a mirrored repo. Updates should go through github.
4+
enable-campaigned-updates: false
5+
enable-security-updates: false

.github/copilot-instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ In addition to the rules enforced by `.editorconfig`, you SHOULD:
2323
- When running tests, if possible use filters and check test run counts, or look at test logs, to ensure they actually ran.
2424
- Do not finish work with any tests commented out or disabled that were not previously commented out or disabled.
2525
- When writing tests, do not emit "Act", "Arrange" or "Assert" comments.
26+
- For markdown (`.md`) files, ensure there is no trailing whitespace at the end of any line.
27+
- When adding XML documentation to APIs, follow the guidelines at [`docs.prompt.md`](/.github/prompts/docs.prompt.md).
2628

2729
---
2830

.github/prompts/docs.prompt.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
mode: 'agent'
3+
tools: ['changes', 'codebase', 'editFiles', 'problems']
4+
description: 'Ensure that C# types are documented with XML comments and follow best practices for documentation.'
5+
---
6+
7+
# C# Documentation Best Practices
8+
9+
- Public members should be documented with XML comments.
10+
- It is encouraged to document internal members as well, especially if they are complex or not self-explanatory.
11+
12+
## Guidance for all APIs
13+
14+
- Use `<summary>` to provide a brief, one sentence, description of what the type or member does. Start the summary with a present-tense, third-person verb.
15+
- Use `<remarks>` for additional information, which can include implementation details, usage notes, or any other relevant context.
16+
- Use `<see langword>` for language-specific keywords like `null`, `true`, `false`, `int`, `bool`, etc.
17+
- Use `<c>` for inline code snippets.
18+
- Use `<example>` for usage examples on how to use the member.
19+
- Use `<code>` for code blocks. `<code>` tags should be placed within an `<example>` tag. Add the language of the code example using the `language` attribute, for example, `<code language="csharp">`.
20+
- Use `<see cref>` to reference other types or members inline (in a sentence).
21+
- Use `<seealso>` for standalone (not in a sentence) references to other types or members in the "See also" section of the online docs.
22+
- Use `<inheritdoc/>` to inherit documentation from base classes or interfaces.
23+
- Unless there is major behavior change, in which case you should document the differences.
24+
25+
## Methods
26+
27+
- Use `<param>` to describe method parameters.
28+
- The description should be a noun phrase that doesn't specify the data type.
29+
- Begin with an introductory article.
30+
- If the parameter is a flag enum, start the description with "A bitwise combination of the enumeration values that specifies...".
31+
- If the parameter is a non-flag enum, start the description with "One of the enumeration values that specifies...".
32+
- If the parameter is a Boolean, the wording should be of the form "`<see langword="true" />` to ...; otherwise, `<see langword="false" />`.".
33+
- If the parameter is an "out" parameter, the wording should be of the form "When this method returns, contains .... This parameter is treated as uninitialized.".
34+
- Use `<paramref>` to reference parameter names in documentation.
35+
- Use `<typeparam>` to describe type parameters in generic types or methods.
36+
- Use `<typeparamref>` to reference type parameters in documentation.
37+
- Use `<returns>` to describe what the method returns.
38+
- The description should be a noun phrase that doesn't specify the data type.
39+
- Begin with an introductory article.
40+
- If the return type is Boolean, the wording should be of the form "`<see langword="true" />` if ...; otherwise, `<see langword="false" />`.".
41+
42+
## Constructors
43+
44+
- The summary wording should be "Initializes a new instance of the <Class> class [or struct].".
45+
46+
## Properties
47+
48+
- The `<summary>` should start with:
49+
- "Gets or sets..." for a read-write property.
50+
- "Gets..." for a read-only property.
51+
- "Gets [or sets] a value that indicates whether..." for properties that return a Boolean value.
52+
- Use `<value>` to describe the value of the property.
53+
- The description should be a noun phrase that doesn't specify the data type.
54+
- If the property has a default value, add it in a separate sentence, for example, "The default is `<see langword="false" />`".
55+
- If the value type is Boolean, the wording should be of the form "`<see langword="true" />` if ...; otherwise, `<see langword="false" />`. The default is ...".
56+
57+
## Exceptions
58+
59+
- Use `<exception cref>` to document exceptions thrown by constructors, properties, indexers, methods, operators, and events.
60+
- Document all exceptions thrown directly by the member.
61+
- For exceptions thrown by nested members, document only the exceptions users are most likely to encounter.
62+
- The description of the exception describes the condition under which it's thrown.
63+
- Omit "Thrown if ..." or "If ..." at the beginning of the sentence. Just state the condition directly, for example "An error occurred when accessing a Message Queuing API."

.github/workflows/aspnetcore-sync.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ jobs:
1616
runs-on: windows-latest
1717
steps:
1818
- name: Checkout aspnetcore
19-
uses: actions/checkout@v5
19+
uses: actions/checkout@v6
2020
with:
2121
# Test this script using changes in a fork
2222
repository: 'dotnet/aspnetcore'
2323
path: aspnetcore
2424
ref: main
2525
- name: Checkout runtime
26-
uses: actions/checkout@v5
26+
uses: actions/checkout@v6
2727
with:
2828
# Test this script using changes in a fork
2929
repository: 'dotnet/runtime'
@@ -42,7 +42,7 @@ jobs:
4242
mkdir ..\artifacts
4343
git status > ..\artifacts\status.txt
4444
git diff > ..\artifacts\diff.txt
45-
- uses: actions/upload-artifact@v4
45+
- uses: actions/upload-artifact@v5
4646
with:
4747
name: results
4848
path: artifacts

.github/workflows/backport.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ jobs:
4646
4747
**IMPORTANT**: If this backport is for a servicing release, please verify that:
4848
49-
- The PR target branch is `release/X.0-staging`, not `release/X.0`.
49+
- For .NET 8 and .NET 9: The PR target branch is `release/X.0-staging`, not `release/X.0`.
50+
- For .NET 10+: The PR target branch is `release/X.0` (no `-staging` suffix).
5051
5152
## Package authoring no longer needed in .NET 9
5253

.github/workflows/bump-chrome-version.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
runs-on: ubuntu-latest
1717
steps:
1818
- name: Checkout
19-
uses: actions/checkout@v5
19+
uses: actions/checkout@v6
2020
- name: Setup Branch
2121
run: |
2222
git config user.name github-actions[bot]

.github/workflows/copilot-setup-steps.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
# You can define any steps you want, and they will run before the agent starts.
1616
# If you do not check out your code, Copilot will do this for you.
1717
steps:
18-
- uses: actions/checkout@v5
18+
- uses: actions/checkout@v6
1919

2020
- name: Install Dependencies
2121
env:

.github/workflows/jit-format.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
with:
3434
dotnet-version: '8.0.x'
3535
- name: Checkout runtime
36-
uses: actions/checkout@v5
36+
uses: actions/checkout@v6
3737
with:
3838
path: runtime
3939
- name: Install Python
@@ -46,7 +46,7 @@ jobs:
4646
ROOTFS_DIR: ${{ matrix.os.rootfs }}
4747

4848
- name: Publish format.patch
49-
uses: actions/upload-artifact@v4
49+
uses: actions/upload-artifact@v5
5050
with:
5151
path: runtime/format.patch
5252
name: format.${{matrix.os.name}}.patch

.github/workflows/locker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
if: ${{ github.repository_owner == 'dotnet' }}
2424
steps:
2525
- name: Checkout Actions
26-
uses: actions/checkout@v5
26+
uses: actions/checkout@v6
2727
with:
2828
repository: "microsoft/vscode-github-triage-actions"
2929
path: ./actions

0 commit comments

Comments
 (0)