From c4698efd1c23cd93f45f6f8bc60cb0d7ee59fb22 Mon Sep 17 00:00:00 2001 From: Pedram Rezaei Date: Sat, 12 Sep 2026 15:25:40 -0700 Subject: [PATCH 1/2] Fix README rendering on NuGet --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dcefde4..ec3455c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[][Cloudtoid] +[Cloudtoid][Cloudtoid] # Code Analysis @@ -11,7 +11,7 @@ This is a collection of code analysis rules that we found most *sensible* to use The NuGet package for this library is published [here][NuGet]. [Cloudtoid]:https://github.com/cloudtoid -[License]:https://github.com/cloudtoid/code-analysis/blob/master/LICENSE +[License]:https://github.com/cloudtoid/code-analysis/blob/main/LICENSE [LicenseBadge]:https://img.shields.io/badge/License-MIT-blue.svg [WorkflowBadgePublish]:https://github.com/cloudtoid/code-analysis/workflows/publish/badge.svg [PublishWorkflow]:https://github.com/cloudtoid/code-analysis/actions/workflows/publish.yml From bab74b66a3b7c9d671016d8c27bd726723ebec38 Mon Sep 17 00:00:00 2001 From: Pedram Rezaei Date: Sat, 12 Sep 2026 15:27:36 -0700 Subject: [PATCH 2/2] Add dedicated NuGet package documentation --- PACKAGE_README.md | 23 +++++++++++++++++++++++ README.md | 4 ++-- src/Cloudtoid.CodeAnalysis.csproj | 4 ++-- 3 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 PACKAGE_README.md diff --git a/PACKAGE_README.md b/PACKAGE_README.md new file mode 100644 index 0000000..4942462 --- /dev/null +++ b/PACKAGE_README.md @@ -0,0 +1,23 @@ +# Cloudtoid.CodeAnalysis + +Shared C# analyzer configuration for projects that use Cloudtoid's coding conventions. The package brings together StyleCop and Visual Studio threading analyzers with a common ruleset and build settings. + +## Install + +Requires a project targeting .NET 10 or later. + +```sh +dotnet add package Cloudtoid.CodeAnalysis +``` + +For a library, keep this build-time dependency private by adding `PrivateAssets="all"` to its `PackageReference`. + +## What it configures + +- Installs StyleCop and Visual Studio threading analyzers. +- Imports the Cloudtoid ruleset and StyleCop configuration during builds. +- Enables warnings as errors. + +Build your project after installation to see diagnostics. Review the rules before adopting the package in an existing codebase: warnings can become build failures. + +[Source and rules](https://github.com/cloudtoid/code-analysis) · [Report an issue](https://github.com/cloudtoid/code-analysis/issues) · [MIT license](https://github.com/cloudtoid/code-analysis/blob/main/LICENSE) diff --git a/README.md b/README.md index ec3455c..dcefde4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[Cloudtoid][Cloudtoid] +[][Cloudtoid] # Code Analysis @@ -11,7 +11,7 @@ This is a collection of code analysis rules that we found most *sensible* to use The NuGet package for this library is published [here][NuGet]. [Cloudtoid]:https://github.com/cloudtoid -[License]:https://github.com/cloudtoid/code-analysis/blob/main/LICENSE +[License]:https://github.com/cloudtoid/code-analysis/blob/master/LICENSE [LicenseBadge]:https://img.shields.io/badge/License-MIT-blue.svg [WorkflowBadgePublish]:https://github.com/cloudtoid/code-analysis/workflows/publish/badge.svg [PublishWorkflow]:https://github.com/cloudtoid/code-analysis/actions/workflows/publish.yml diff --git a/src/Cloudtoid.CodeAnalysis.csproj b/src/Cloudtoid.CodeAnalysis.csproj index 4d1396b..7401237 100644 --- a/src/Cloudtoid.CodeAnalysis.csproj +++ b/src/Cloudtoid.CodeAnalysis.csproj @@ -6,7 +6,7 @@ - README.md + PACKAGE_README.md Cloudtoid.CodeAnalysis Cloudtoid.CodeAnalysis pedram@rezaei.us @@ -37,7 +37,7 @@ - +