NuGet/Home

Don't default package description to "Package Description".

已關閉

#8,966 建立於 2019年12月23日

在 GitHub 查看貢獻者指南
 (10 則留言) (3 個反應) (0 位負責人)HTML (292 個分叉)batch import
Area:PackageDefinitionFunctionality:PackIcebox cleanup candidatePriority:3Status:InactiveType:Bughelp wanted

倉庫指標

星標
 (1,459 顆星)
PR 合併指標
 (平均合併 464天 23小時) (30 天內合併 1 個 PR)

描述

If I create a new class library project (sdk-style) and "pack" it, it produces a package with a description of "Package Description". I can override this by providing a <Description> property in my csproj (such an override cannot be empty). If it is a required field in the package, make it a build error (with an explanation of how to define it) if it isn't defined rather than defaulting it to a useless value.

If you don't think this is a problem, then I would counter with: https://www.nuget.org/packages?q=%22Package+Description%22 21,031 results

Even a lot of Microsoft's own packages have this default description. Honestly, it's a bit embarrassing.

貢獻者指南

研究方向
The issue suggests making the package description required by throwing a build error if not defined instead of defaulting to 'Package Description'. To implement this, one would need to locate where the default description is set in the NuGet client code, likely in the packaging task or in the build logic. Look in the NuGet.Client repository for the code that generates the nuspec or package metadata. The change would involve either removing the default or adding a check to error if the Description property is not explicitly set in the project file. There are no linked PRs or assignees, so this issue is available for contribution.
技術棧
csharp
領域
build systemdeveloper experience
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
較久未更新
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Basic understanding of NuGet packagingFamiliarity with .NET project files
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60