fix: strip internal doc/ADR references from published package descriptions - #61
Merged
Merged
Conversation
…tions 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.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Found while running through Milestone 8's Release-readiness/Public-preview acceptance checklists post-publish, checking what an actual stranger sees on nuget.org search.
The live
Componopackage's nuget.org search result — the literal first-impression text before anyone reaches the README — currently reads: "...No dependency on any test framework, mocking framework, or Bogus - see docs/manifesto.md's 'Modular by design' and design-decisions.md rule 3."docs/manifesto.mdis a page Phase 5 already retired to a tombstone;design-decisions.mdnever existed as a public file at all — it's this repo's internal Claude Code engineering-workflow skill reference, never shipped anywhere a nuget.org visitor could resolve it.The other three packages'
Descriptionfields had the identical pattern, each citing an internaldocs/adr/...path.Same bug class #58 already fixed once (stale internal references leaking into user-facing text) — that PR covered XML doc comments and a diagnostic message; this is the same defect in NuGet package metadata. Rewrote all four
Descriptionfields to stand on their own with no internal-path citations.Test plan
dotnet build Compono.slnx -c Release— 0 warnings, 0 errorsdotnet test Compono.slnx -c Release— 871/871 passeddotnet packofCompono— confirmed the shipped.nuspec's<description>carries the clean text🤖 Generated with Claude Code