NuGet/Home

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

Closed

#8,966 opened on Dec 23, 2019

View on GitHubContributor guide
 (10 comments) (3 reactions) (0 assignees)HTML (292 forks)batch import
Area:PackageDefinitionFunctionality:PackIcebox cleanup candidatePriority:3Status:InactiveType:Bughelp wanted

Repository metrics

Stars
 (1,459 stars)
PR merge metrics
 (Avg merge 464d 23h) (1 merged PR in 30d)

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.

Contributor guide

Research direction
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
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic understanding of NuGet packagingFamiliarity with .NET project files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60