Skip to content

Add dedicated NuGet package README #4

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

Merged
prezaei merged 2 commits into from
Sep 12, 2026
Merged

Add dedicated NuGet package README #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4698ef
Fix README rendering on NuGet
Sep 12, 2026
bab74b6
Add dedicated NuGet package documentation
Sep 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions PACKAGE_README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions src/Cloudtoid.CodeAnalysis.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<!-- NuGet Packaging -->
<PropertyGroup>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageReadmeFile>PACKAGE_README.md</PackageReadmeFile>
<PackageId>Cloudtoid.CodeAnalysis</PackageId>
<Title>Cloudtoid.CodeAnalysis</Title>
<Authors>pedram@rezaei.us</Authors>
Expand Down Expand Up @@ -37,7 +37,7 @@
</ItemGroup>

<ItemGroup>
<None Include="../README.md" Pack="true" PackagePath="/" />
<None Include="../PACKAGE_README.md" Pack="true" PackagePath="/" />
</ItemGroup>

</Project>