Rework NuGet PACKAGE.md for Microsoft.Testing.Platform and extensions#7450
Rework NuGet PACKAGE.md for Microsoft.Testing.Platform and extensions#7450Evangelink wants to merge 9 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reworks all NuGet README files (PACKAGE.md) for Microsoft.Testing.Platform and its extensions with a unified, detailed, and professional documentation style. The updates replace generic documentation with package-specific information that helps developers understand what each package does, when to use it, and how it relates to other packages in the ecosystem.
Changes:
- Standardized structure across all PACKAGE.md files with actual package names as titles, detailed About sections, installation instructions, and cross-references
- Added two new PACKAGE.md files for Microsoft.Testing.Platform.AI and Microsoft.Testing.Extensions.AzureFoundry
- Clarified that VSTestBridge is for test framework authors, not end-users, and that OpenTelemetry sends data only to user-configured endpoints
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Platform/Microsoft.Testing.Platform/PACKAGE.md | Updated core platform documentation with detailed description of test host, extensibility model, and protocol |
| src/Platform/Microsoft.Testing.Platform.MSBuild/PACKAGE.md | Enhanced MSBuild integration documentation with details on dotnet test support and configuration file generation |
| src/Platform/Microsoft.Testing.Platform.AI/PACKAGE.md | New file documenting AI extensibility abstractions and IChatClientProvider interface |
| src/Platform/Microsoft.Testing.Extensions.VSTestBridge/PACKAGE.md | Clarified target audience (test framework authors) and compatibility bridge functionality |
| src/Platform/Microsoft.Testing.Extensions.TrxReport/PACKAGE.md | Enhanced TRX report documentation with CI integration details and related packages |
| src/Platform/Microsoft.Testing.Extensions.TrxReport.Abstractions/PACKAGE.md | Updated abstractions documentation with clarity on extensibility for third-party extensions |
| src/Platform/Microsoft.Testing.Extensions.Telemetry/PACKAGE.md | Added details on opt-out support and privacy-first approach |
| src/Platform/Microsoft.Testing.Extensions.Retry/PACKAGE.md | Enhanced retry extension documentation with flaky test management details |
| src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md | Clarified that data is sent only to user-configured endpoints, not to Microsoft |
| src/Platform/Microsoft.Testing.Extensions.HotReload/PACKAGE.md | Updated Hot Reload documentation with IDE integration details |
| src/Platform/Microsoft.Testing.Extensions.HangDump/PACKAGE.md | Enhanced hang dump documentation with cross-reference to CrashDump package |
| src/Platform/Microsoft.Testing.Extensions.CrashDump/PACKAGE.md | Updated crash dump documentation with cross-reference to HangDump package |
| src/Platform/Microsoft.Testing.Extensions.AzureFoundry/PACKAGE.md | New file documenting Azure AI Foundry integration for AI-powered testing |
| src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/PACKAGE.md | Enhanced Azure DevOps reporting documentation with pipeline integration details |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md:20
- The README describes this package as an "OpenTelemetry exporter" that exports via OTLP, but the implementation only creates TracerProvider/MeterProvider builders and does not configure any exporters by default. This is misleading for consumers: please reword to clarify that this package enables OpenTelemetry tracing/metrics and that users must configure an exporter (e.g., OTLP) via the provided configuration delegates for telemetry to be emitted.
- **OpenTelemetry exporter**: exports test execution data (traces, metrics) using the OpenTelemetry protocol (OTLP)
- **Observability**: integrate test execution data into your existing observability stack (e.g. Jaeger, Prometheus, Grafana)
- **Standards-based**: leverages the OpenTelemetry .NET SDK for broad compatibility with telemetry backends
- **Your data, your infrastructure**: telemetry data is sent exclusively to the OTLP endpoint you configure — no data is sent to Microsoft
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md
Outdated
Show resolved
Hide resolved
src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/PACKAGE.md
Outdated
Show resolved
Hide resolved
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md
Outdated
Show resolved
Hide resolved
Rework all NuGet README files (PACKAGE.md) for Microsoft.Testing.Platform and its extensions with a unified, detailed style: - Use the actual package name as the title instead of generic 'Microsoft.Testing' - Add a descriptive introduction paragraph with a NuGet link to Microsoft.Testing.Platform - Add 'Install the package' section with dotnet CLI command - Add detailed 'About' section with key features as bullet points - Add 'Related packages' cross-references for closely related extensions (diagnostics: CrashDump/HangDump, reporting: TrxReport/TrxReport.Abstractions/AzureDevOpsReport, AI: Platform.AI/AzureFoundry) - Add 'Documentation' and 'Feedback & contributing' sections with links - Add missing PACKAGE.md for Microsoft.Testing.Platform.AI and Microsoft.Testing.Extensions.AzureFoundry - Clarify VSTestBridge is a test framework author extension, not for end-user projects - Clarify OpenTelemetry extension sends data only to user-configured endpoints, not to Microsoft
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Youssef Victor <youssefvictor00@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
7b1c1af to
f5def6d
Compare
| # Microsoft.Testing.Extensions.AzureDevOpsReport | ||
|
|
||
| Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. | ||
| Microsoft.Testing.Extensions.AzureDevOpsReport is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that reports individual test failures as errors or warnings in Azure DevOps CI builds, with file/line annotations when available. |
There was a problem hiding this comment.
@nohwnd Does it work only when hosted on GitHub? Or is it a generic AzDO syntax that's handled everywhere?
| This package extends Microsoft.Testing.Platform with: | ||
|
|
||
| - **Crash dump collection**: automatically captures a memory dump when the test process crashes | ||
| - **Post-mortem debugging**: collected dumps can be analyzed with tools like Visual Studio, WinDbg, or `dotnet-dump` |
There was a problem hiding this comment.
I think dumps collected on macOS can only be analyzed on macOS as well. Should we note that?
Rework all NuGet README files (PACKAGE.md) for Microsoft.Testing.Platform and its extensions with a unified, detailed style: