docs icon indicating copy to clipboard operation
docs copied to clipboard

Enhance documentation for TUnit integration and usage

Open thomhurst opened this issue 3 weeks ago • 2 comments

This pull request expands documentation for TUnit, a .NET testing framework built on Microsoft.Testing.Platform, and clarifies its support for various extensibility features and workflows. The changes improve coverage of TUnit in comparison to other frameworks, add practical examples for advanced scenarios (such as filtering, ordering, code coverage, and mutation testing), and update documentation to show that Microsoft.Testing.Platform extensions work with TUnit.

TUnit documentation enhancements:

  • Added detailed description of TUnit, including its use of source generation, parallel test execution, and links to official documentation and language-specific guides. [1] [2]
  • Added comprehensive examples for filtering TUnit tests with dotnet test --filter, including supported attributes and operator usage. [1] [2]
  • Provided an example of ordering TUnit tests using the [DependsOn] attribute, covering dependency handling, failure behavior, and method overloads.

Integration with Microsoft.Testing.Platform extensions:

  • Clarified that Microsoft.Testing.Platform extensions for output, test reports, code coverage, and architecture work with TUnit, in addition to MSTest, NUnit, and xUnit. [1] [2] [3] [4]

Advanced testing scenarios with TUnit:

  • Added sections on using code coverage tools (e.g., Coverlet, ReportGenerator) and mutation testing (Stryker.NET) with TUnit, including async test patterns and project setup instructions. [1] [2] [3]

Internal previews

📄 File 🔗 Preview link
docs/core/testing/index.md Testing in .NET
docs/core/testing/microsoft-testing-platform-intro.md Microsoft.Testing.Platform overview
docs/core/testing/order-unit-tests.md Order unit tests
docs/core/testing/selective-unit-tests.md Run selected unit tests
docs/core/testing/unit-testing-code-coverage.md docs/core/testing/unit-testing-code-coverage
docs/core/testing/unit-testing-csharp-with-tunit.md Unit testing C# in .NET using dotnet test and TUnit
docs/core/testing/unit-testing-fsharp-with-tunit.md Unit testing F# in .NET Core with dotnet test and TUnit
docs/core/testing/unit-testing-visual-basic-with-tunit.md Unit testing Visual Basic .NET Core libraries using dotnet test and TUnit
docs/zone-pivot-groups.yml docs/zone-pivot-groups

thomhurst avatar Nov 22 '25 16:11 thomhurst