Skip to content

Fix docs stating incorrect default for coverage output format #3936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 29, 2025
Merged

Fix docs stating incorrect default for coverage output format #3936

merged 2 commits into from
Nov 29, 2025

Conversation

Copy link
Contributor

Copilot AI commented Nov 29, 2025 •
edited
Loading

Please check the following before creating a Pull Request

  • If this is a new feature or piece of functionality, have you started a discussion and gotten agreement on it?
  • If it fixes a bug or problem, is there an issue to track it? If not, create one first and link it please so there's clear visibility.
  • Did you write tests to ensure you code works properly?

Fixes #3316

Documentation incorrectly stated Cobertura is the default coverage output format. .NET 10 produces binary .coverage files by default when --coverage-output-format is not supplied.

Changes:

  • Updated comments from (default is cobertura) → (default is binary .coverage file) in migration guides (xunit, nunit, mstest) and extensions docs
  • Removed incorrect (default, widely supported) label from Cobertura examples, now just (widely supported)

Files updated:

  • docs/docs/migration/xunit.md
  • docs/docs/migration/nunit.md
  • docs/docs/migration/mstest.md
  • docs/docs/extensions/extensions.md
  • docs/docs/troubleshooting.md
Original prompt

This section details on the original issue you should resolve

<issue_title>Docs state an incorrect default for coverage</issue_title>
<issue_description>https://tunit.dev/docs/migration/xunit/#coverage-output-formats states that Cobertura is the default. However, .NET 10 produces binary .coverage files if the --coverage-output-format is not supplied.</issue_description>

Comments on the Issue (you are @copilot in this section)

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@thomhurst
Fix docs stating incorrect default for coverage output format
0a75add 
The documentation incorrectly stated that Cobertura is the default coverage
output format. However, .NET 10 produces binary .coverage files by default
if the --coverage-output-format flag is not supplied.

Fixes documentation in migration guides (xunit, nunit, mstest), extensions,
and troubleshooting files.

Co-authored-by: thomhurst <30480171+thomhurst@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix incorrect default coverage format in documentation Fix docs stating incorrect default for coverage output format Nov 29, 2025
Copilot AI requested a review from thomhurst November 29, 2025 10:08
Copilot finished work on behalf of thomhurst November 29, 2025 10:08
@thomhurst thomhurst marked this pull request as ready for review November 29, 2025 10:19
@thomhurst thomhurst merged commit fe8b799 into main Nov 29, 2025
5 checks passed
@thomhurst thomhurst deleted the copilot/fix-docs-coverage-default branch November 29, 2025 10:19
This was referenced Dec 1, 2025
Open
Closed
Open
Open
Merged
Merged
Merged
Open
Open
Closed
Merged
Closed
Open
Open
Closed
Open
Merged
Closed
Merged
This was referenced Dec 1, 2025
Merged
Open
Open
Merged
Merged
Merged
Open
Open
Open
Open
Open
Merged
Open
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thomhurst thomhurst Awaiting requested review from thomhurst

Assignees

@thomhurst thomhurst

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs state an incorrect default for coverage

2 participants

@thomhurst