NuGet/Home

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

Fermée

#8 966 ouverte le 23 déc. 2019

Voir sur GitHubGuide contributeur
 (10 commentaires) (3 réactions) (0 personne assignée)HTML (292 forks)batch import
Area:PackageDefinitionFunctionality:PackIcebox cleanup candidatePriority:3Status:InactiveType:Bughelp wanted

Métriques du dépôt

Stars
 (1 459 étoiles)
Métriques de merge PR
 (Merge moyen 464j 23h) (1 PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
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.
Stack technique
csharp
Domaine
build systemdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic understanding of NuGet packagingFamiliarity with .NET project files
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60