From 27f36b59f242bc5e4db0a812b587797d45e95f4f Mon Sep 17 00:00:00 2001 From: Nick Cipollina Date: Thu, 6 Aug 2026 22:54:54 -0400 Subject: [PATCH] fix: strip internal doc/ADR references from published package descriptions Found while closing out Milestone 8: the live nuget.org search result for Compono (the actual first-impression text a stranger sees, before they ever reach the README) cited docs/manifesto.md - retired to a tombstone in Phase 5 - and design-decisions.md, which never existed as a public file at all (an internal engineering-workflow skill reference). The other three packages' Description fields had the same pattern, citing internal docs/adr/... paths a nuget.org visitor has no way to resolve. Same bug class PR #58 already fixed once in XML doc comments and a diagnostic message - this is the same defect in NuGet package metadata instead. Rewrote all four Description fields to stand on their own, no internal-path citations. Confirmed via a real pack: the shipped .nuspec now carries the clean description. --- src/Compono.Bogus/Compono.Bogus.csproj | 2 +- src/Compono.NSubstitute/Compono.NSubstitute.csproj | 2 +- src/Compono.XunitV3/Compono.XunitV3.csproj | 2 +- src/Compono/Compono.csproj | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Compono.Bogus/Compono.Bogus.csproj b/src/Compono.Bogus/Compono.Bogus.csproj index 6a0c738..f1d555e 100644 --- a/src/Compono.Bogus/Compono.Bogus.csproj +++ b/src/Compono.Bogus/Compono.Bogus.csproj @@ -6,7 +6,7 @@ enable net10.0;net11.0 Compono — Bogus Integration - Bogus integration for Compono - a conservative member-name-convention semantic provider, plus explicit member-level and whole-object Faker sugar. See docs/adr/0026-deterministic-seed-derivation-for-providers.md and docs/adr/0027-compono-bogus-package-design.md. + Bogus integration for Compono - a conservative member-name-convention semantic provider, plus explicit member-level and whole-object Faker sugar. diff --git a/src/Compono.NSubstitute/Compono.NSubstitute.csproj b/src/Compono.NSubstitute/Compono.NSubstitute.csproj index 277864e..5ef14ad 100644 --- a/src/Compono.NSubstitute/Compono.NSubstitute.csproj +++ b/src/Compono.NSubstitute/Compono.NSubstitute.csproj @@ -6,7 +6,7 @@ enable net10.0;net11.0 Compono — NSubstitute Integration - NSubstitute integration for Compono - a test-double provider composing interface, delegate, and (optionally) abstract-class parameters as real NSubstitute substitutes. See docs/adr/0024-public-provider-extensibility-model.md and docs/adr/0025-compono-nsubstitute-package-design.md. + NSubstitute integration for Compono - a test-double provider composing interface, delegate, and (optionally) abstract-class parameters as real NSubstitute substitutes. diff --git a/src/Compono.XunitV3/Compono.XunitV3.csproj b/src/Compono.XunitV3/Compono.XunitV3.csproj index baccbf5..66139a7 100644 --- a/src/Compono.XunitV3/Compono.XunitV3.csproj +++ b/src/Compono.XunitV3/Compono.XunitV3.csproj @@ -6,7 +6,7 @@ enable net10.0;net11.0 Compono — xUnit v3 Integration - xUnit v3 integration for Compono - [Compose]/[Compose<TProfile>] theory data attributes and [Shared] parameter sharing. See docs/adr/0022-compono-xunit-package-design.md and docs/adr/0023-rename-compono-xunit-to-compono-xunitv3.md. + xUnit v3 integration for Compono - [Compose]/[Compose<TProfile>] theory data attributes and [Shared] parameter sharing. diff --git a/src/Compono/Compono.csproj b/src/Compono/Compono.csproj index 4b54d7a..b031979 100644 --- a/src/Compono/Compono.csproj +++ b/src/Compono/Compono.csproj @@ -6,7 +6,7 @@ enable net10.0;net11.0 Compono — Core Composition Engine - Core composition engine for Compono, a modern, source-generated test composition framework for .NET - CompositionContext, the provider resolution pipeline, and the built-in source generator. No dependency on any test framework, mocking framework, or Bogus - see docs/manifesto.md's "Modular by design" and design-decisions.md rule 3. + Core composition engine for Compono, a modern, source-generated test composition framework for .NET - CompositionContext, the provider resolution pipeline, and the built-in source generator. No dependency on any test framework, mocking framework, or Bogus - those integrations are separate, optional packages.