Skip to content

Docs: fix MSTest.Sdk badge URLs and typo in dev-guide#8862

Merged
Evangelink merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/readme-fixes
Jun 5, 2026
Merged

Docs: fix MSTest.Sdk badge URLs and typo in dev-guide#8862
Evangelink merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/readme-fixes

Conversation

@Evangelink
Copy link
Copy Markdown
Member

@Evangelink Evangelink commented Jun 5, 2026

Small documentation fixes spotted while reviewing the repo entry points (README.md, CONTRIBUTING.md, docs/README.md, docs/dev-guide.md).

README.md

Fix MSTest.Sdk badge URLs

The MSTest.Sdk row in the package table used mstest.svg / mstest/vpre.svg for the stable/preview badges:

[![#](https://img.shields.io/nuget/v/mstest.svg?style=flat)](http://www.nuget.org/packages/MSTest.Sdk/)
[![#](https://img.shields.io/nuget/vpre/mstest.svg?style=flat)](http://www.nuget.org/packages/MSTest.Sdk/)

That made the badges show the version of the MSTest meta-package while linking to MSTest.Sdk — i.e. badge and link disagreed, and readers landing on the SDK row got the wrong version number. Now pointing the badge URLs at mstest.sdk.svg so they match the row's package (and the existing Azure Artifacts link).

Name consistency

MSTest, Microsoft Testing Framework, is a testing framework... — the same file's H1 is Microsoft Test Framework (MSTest). Replaced Testing -> Test to match.

docs/dev-guide.md

Typo (assets -> asserts)

The Debug/Release explanation said:

...the Release version...doesn't have any assets and has all code optimizations enabled.

The sentence is contrasting Release with the previous claim that Debug "includes asserts". Fixed the typo.

.Net -> .NET

In the VS workloads list, .Net Core cross-platform development — the two bullets above it already use .NET.

Build layout table missing TestResults

The artifacts/ directory tree lists TestResults but the legend table below doesn't describe it. Added a row.

docs/README.md

Writing your first test with mstest was the first bullet under "you can refer to the list of RFCs" — it's a learn.microsoft.com tutorial, not an RFC. Moved it into the "detailed examples" list above (where similar tutorial links live) and capitalized mstest -> MSTest.

Verification

No behavioral or build impact — Markdown-only doc changes.

* README.md: the MSTest.Sdk row used mstest.svg / mstest/vpre.svg for the stable/preview badges, which displays the MSTest meta-package version instead of the actual MSTest.Sdk version. Point the badges at mstest.sdk.svg.

* docs/dev-guide.md: fix typo `doesn't have any assets` -> `doesn't have any asserts` (the sentence contrasts Debug `includes asserts` with Release; `assets` is unrelated and makes the sentence misleading).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 5, 2026 14:54
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes two small documentation corrections in the repo entry-point docs: it fixes the NuGet badge URLs for MSTest.Sdk in the main README so the displayed version matches the linked package, and corrects a typo in the dev guide’s Debug/Release explanation.

Changes:

  • Update README.md so the MSTest.Sdk stable/preview Shields.io badge URLs point to mstest.sdk (instead of mstest).
  • Fix a typo in docs/dev-guide.md (“assets” → “asserts”) in the Release build description.
Show a summary per file
File Description
README.md Corrects MSTest.Sdk NuGet badge URLs to match the package linked in the table row.
docs/dev-guide.md Fixes a typo in the Debug vs Release build description (“assets” → “asserts”).

Copilot's findings

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

@Evangelink Evangelink enabled auto-merge (squash) June 5, 2026 14:59
@Evangelink Evangelink merged commit ddfcc17 into microsoft:main Jun 5, 2026
20 checks passed
@Evangelink Evangelink deleted the dev/amauryleve/readme-fixes branch June 5, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants