Docs: fix MSTest.Sdk badge URLs and typo in dev-guide#8862
Merged
Conversation
* 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>
Contributor
There was a problem hiding this comment.
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.mdso theMSTest.Sdkstable/preview Shields.io badge URLs point tomstest.sdk(instead ofmstest). - 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
azat-msft
approved these changes
Jun 5, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Small documentation fixes spotted while reviewing the repo entry points (
README.md,CONTRIBUTING.md,docs/README.md,docs/dev-guide.md).README.mdFix MSTest.Sdk badge URLs
The
MSTest.Sdkrow in the package table usedmstest.svg/mstest/vpre.svgfor the stable/preview badges:That made the badges show the version of the
MSTestmeta-package while linking toMSTest.Sdk— i.e. badge and link disagreed, and readers landing on the SDK row got the wrong version number. Now pointing the badge URLs atmstest.sdk.svgso 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 isMicrosoft Test Framework (MSTest). ReplacedTesting->Testto match.docs/dev-guide.mdTypo (
assets->asserts)The Debug/Release explanation said:
The sentence is contrasting Release with the previous claim that Debug "includes asserts". Fixed the typo.
.Net->.NETIn the VS workloads list,
.Net Core cross-platform development— the two bullets above it already use.NET.Build layout table missing
TestResultsThe
artifacts/directory tree listsTestResultsbut the legend table below doesn't describe it. Added a row.docs/README.mdWriting your first test with mstestwas 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 capitalizedmstest->MSTest.Verification
No behavioral or build impact — Markdown-only doc changes.