CPMR0057 - Nuspec Enhancements Missing (nuspec)

CPMR0057 - Nuspec Enhancements Missing (nuspec)

⚠️ This rule has been marked as a Suggestion

Suggestions are either newly introduced items that will later become Guidelines or items that are don't carry enough weight to become a Guideline. Either way they should be considered. A package version can be approved without addressing Suggestion comments.

Issue

The nuspec is missing the recent enhancements that give consumers information related to the underlying software.

Please update the nuspec to contain one or more of the following:

  • docsUrl - points to the location of the wiki or docs of the software
  • mailingListUrl - points to the forum or email list group for the software
  • bugTrackerUrl - points to the location where issues and tickets can be accessed
  • packageSourceUrl - points to the location of your chocolatey package files in source (e.g. https://github.com/chocolatey-community/chocolatey-packages)
  • projectSourceUrl - points to the location of the underlying software source

📝 NOTE You must use choco pack with at least version 0.9.9.7 (see #205) to use these elements. Using NuGet or nuget.exe will error on this element.

📝 NOTE If your nuspec file is missing these fields, you should run choco new testpkg and look at the output from that (ensure you have the latest version of Chocolatey).

Reasoning

This provides folks with more information related to the software itself and gives folks a quick location reference to start from when attempting to find more information related to a project.