Skip to content

Add a README to the NuGet packages - #4204

Merged
AArnott merged 1 commit into
masterfrom
fix-3799-nuget-readme
Oct 9, 2026
Merged

AArnott merged 1 commit into
masterfrom
fix-3799-nuget-readme

Conversation

@AArnott

@AArnott AArnott commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #3799

NuGet.org flags both packages as missing a README. This adds a short, package-focused PackageReadme.md (what the package does, how to install it, how to configure it, and links to docs and release notes) and packs it as README.md in both StyleCop.Analyzers and StyleCop.Analyzers.Unstable via <readme>README.md</readme> in the two nuspecs.

I wrote a separate file rather than packing the repo's README.md, because that one uses relative links and badge images that don't render on NuGet.org, and its install section is about VS2015.

This is a packaging-only change, with no analyzer code or perf impact. minClientVersion stays 2.7. Like the existing <license> element, <readme> only needs a newer NuGet at pack time, and older clients ignore it.

Verification: the nuget-packages artifact from CI run 37950293681 has README.md at the root of both StyleCop.Analyzers.1.2.0-beta.862.g3cdb3c922d.nupkg and StyleCop.Analyzers.Unstable.1.2.0-g3cdb3c922d.nupkg, and both nuspecs contain <readme>README.md</readme>.

@codecov

codecov Bot commented Oct 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.54%. Comparing base (868775d) to head (6dd13ec).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4204   +/-   ##
=======================================
  Coverage   97.54%   97.54%           
=======================================
  Files        1277     1277           
  Lines      134157   134157           
  Branches     4291     4291           
=======================================
+ Hits       130863   130865    +2     
+ Misses       2152     2151    -1     
+ Partials     1142     1141    -1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AArnott
AArnott marked this pull request as ready for review October 9, 2026 15:42
@AArnott
AArnott merged commit f8258eb into master Oct 9, 2026
25 checks passed
@AArnott
AArnott deleted the fix-3799-nuget-readme branch October 9, 2026 17:56
This was referenced Nov 11, 2026
This was referenced Nov 13, 2026
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.

stylecop.analyzers is missing NuGet package README file

2 participants