NuGet/Home

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

クローズ

#8,966 opened on 2019/12/23

GitHub で見るコントリビューターガイド
 (10 件のコメント) (3 件のリアクション) (0 人の担当者)HTML (292 件のフォーク)batch import
Area:PackageDefinitionFunctionality:PackIcebox cleanup candidatePriority:3Status:InactiveType:Bughelp wanted

Repository metrics

Stars
 (1,459 個のスター)
PR merge metrics
 (平均マージ 464d 23h) (30d で 1 merged 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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Basic understanding of NuGet packagingFamiliarity with .NET project files
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60