Skip to content

chore: pack README.md into the NuGet package - #69

Merged
kudima03 merged 1 commit into
mainfrom
chore/pack-readme-into-nuget
Sep 21, 2026
Merged

kudima03 merged 1 commit into
mainfrom
chore/pack-readme-into-nuget

Conversation

@kudima03

Copy link
Copy Markdown
Owner

Problem

Pure.Primitives.Abstractions.OpenAPI.Schema publishes without a readme, so the nuget.org package page renders empty. None of the 72 Pure.* package repositories currently pack their README.md.

Change

In src/Pure.Primitives.Abstractions.OpenAPI.Schema/Pure.Primitives.Abstractions.OpenAPI.Schema.csproj:

  • declare <PackageReadmeFile>README.md</PackageReadmeFile>
  • add an ItemGroup packing ../../README.md at the package root

Licence metadata is deliberately untouched — <PackageLicenseExpression>MIT</PackageLicenseExpression> stays exactly as it was, and no licence file is added to the package.

Verification

The same change was piloted in Pure.Linq.Conditions#107, where dotnet pack produced a package containing README.md at the root with <readme>README.md</readme> in the nuspec, and <license type="expression">MIT</license> unchanged.

Rollout

Part of the same one-file change applied across all 72 Pure.* package repositories.

🤖 Generated with Claude Code

The published package shipped without a readme, so nuget.org rendered an
empty package page. Declare PackageReadmeFile and pack the repository
README at the package root.

Licence metadata is deliberately left untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Code Coverage

Package Line Rate Branch Rate Complexity Health
Pure.Primitives.Abstractions.OpenAPI.Schema 11% 4% 228 ➖
Summary 11% (47 / 424) 4% (8 / 214) 228 ➖

Minimum allowed line rate is 10%

@kudima03
kudima03 merged commit b9ea8a1 into main Sep 21, 2026
1 check passed
@kudima03
kudima03 deleted the chore/pack-readme-into-nuget branch September 21, 2026 11:42
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.

1 participant