-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/dotnet/sdk into dev/Jason/M…
…erge-the-net10-codeflows
- Loading branch information
Showing
323 changed files
with
13,181 additions
and
10,019 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,3 +45,4 @@ cmake/ | |
|
||
# Test results | ||
**/*.trx | ||
/TestResults |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Localization | ||
## Summary | ||
The .NET SDK is translated into 14 languages. In our codebase, you can see the primary resx file lists the strings to be translated. | ||
|
||
### Making changes | ||
The local dev build automatically generates updates to the xlf files that contain the translations. You can see the UpdateXlf task in the binlog to see that in action. | ||
|
||
When making string changes, update the resx, build, and check in all xlf file changes. Developers should never need to update the xlf files directly and should always rely on the local build for updates to those files. This will leave the files in english initially and they will get translated eventually. | ||
|
||
For internal folks, see https://aka.ms/allaboutloc | ||
|
||
### Loc issues | ||
Never manually update the xlf file even if a translation is wrong. Report a bug instead. | ||
|
||
External -- https://aka.ms/provide-feedback | ||
Internal -- https://aka.ms/icxLocFeedback | ||
|
||
### Loc Updates | ||
These are triggered automatically by the loc system as new translations come in. We generally accept these unless we notice it removing translations. | ||
https://github.com/dotnet/sdk/pulls?q=is%3Apr+author%3Adotnet-bot+onelocbuild | ||
|
||
### Loc Builds | ||
We typically only localize the primary development branch. We move to vNext once we get to RC1 and only then, localize all new strings introduced in that release. That way we can continue to add messages in the 4xx release of an SDK. | ||
|
||
This is controlled https://github.com/dotnet/sdk/blob/main/eng/pipelines/templates/jobs/sdk-job-matrix.yml#L86 and requires a change both here and in the loc system to align branches. | ||
|
||
### Translation directives | ||
There are a ton of translations directives our localization system understands. Here are some of the most common in this repo: | ||
|
||
#### Locking translations | ||
If a string or partial string should not be translated, add `{Locked=""}` with the details in the appropriate resx files. If `{Locked}` is used the entire string is locked. This can be specified multiple times, each locking different sections. | ||
|
||
#### Contextual comments | ||
You can use `<comment>` elements inside the `<data>` tags to provide context to translators. | ||
|
||
### String formatting constraints | ||
You can use `{StrBegins=}`, `{StrContains=}` and `{StrEnds=}` to ensure that after translation the string contains the specified values |
39 changes: 39 additions & 0 deletions
39
documentation/project-docs/external-component-telemetry.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Responsibly managing telemetry in external components | ||
|
||
Many components are _delivered_ with or by the .NET SDK but want to collect and | ||
manage telemetry. The SDK has telemetry collection mechanisms that may appear | ||
attractive, but present down-sides for these authors. | ||
|
||
This document clarifies some guidelines for authors of components that are consumed by the .NET SDK but want to own their own telemetry. | ||
|
||
## Sending telemetry | ||
|
||
### DO create and manage your own MSBuild Task for sending telemetry | ||
|
||
This allows you to have full control over the telemetry you send, where it is | ||
sent, and any PII masking requirements that are unique to your product. | ||
Attempting to use the .NET SDK's `AllowEmptyTelemetry` mechanism is not | ||
recommended for most internal partners and all external users. This is because | ||
`AllowEmptyTelemetry` | ||
* is allow-listed for known events only, so your telemetry will not be sent | ||
* sends to the SDK's telemetry storage, which your team may not have access to | ||
* is dependent on the SDK version the user uses, which may lag behind the latest available | ||
|
||
### DO NOT use the MSBuild Engine telemetry APIs for logging telemetry | ||
|
||
These APIs, while convenient, require the MSBuild Engine Host (`dotnet build`, | ||
`msbuild.exe`, Visual Studio Project system) to have configured a telemetry | ||
collector. This is not guaranteed to be the case for all users of your component, | ||
and the collector configured may not send telemetry in the manner you expect, or | ||
to destinations you expect. | ||
|
||
## Managing telemetry | ||
|
||
### DO adhere to the SDK telemetry opt-out | ||
|
||
The SDK has an [opt out](https://learn.microsoft.com/dotnet/core/tools/telemetry#how-to-opt-out) mechanism for telemetry that all SDK-generated | ||
telemetry should adhere to. When running in the context of the SDK that means your | ||
telemetry should adhere to this signal as well. This opt-out mechanism is an | ||
environment variable, but the default value of this variable changes for | ||
Microsoft-authored and source-built SDKs. The SDK should provide a unified | ||
mechanism for tooling authors to rely on instead of probing for this value. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.