NuGet/Home

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

Geschlossen

#8.966 geöffnet am 23.12.2019

Auf GitHub ansehenContributor Guide
 (10 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)HTML (292 Forks)batch import
Area:PackageDefinitionFunctionality:PackIcebox cleanup candidatePriority:3Status:InactiveType:Bughelp wanted

Repository-Metriken

Stars
 (1.459 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 464T 23h) (1 gemergte PR in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
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.
Tech Stack
csharp
Domain
build systemdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic understanding of NuGet packagingFamiliarity with .NET project files
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60