CPMR0033 - IconUrl Missing (nuspec)

CPMR0033 - IconUrl Missing (nuspec)

⚠️ This rule has been marked as a Guideline

Guidelines are strong suggestions that improve the quality of a package version. These are considered something to fix for next time to increase the quality of the package. Over time Guidelines can become Requirements. A package version can be approved without addressing Guideline comments but will reduce the quality of the package.

Issue

The nuspec is missing (or has commented out) the iconUrl, which points to an icon image for the underlying software the package is based on. If there is an existing icon/logo for the software, it should be included with the package.

Add <iconUrl>url_here</iconUrl> to the nuspec following the icon guidelines. If your nuspec file is missing this field, you should run choco new testpkg and look at the output from that (ensure you have the latest version of Chocolatey).

Reasoning

We really want to see the IconUrl being used. It adds to the quality of the package when it has an icon to show. It is best to provide the icon from a source you control such as your GitHub repository, however GitHub raw is not intended to serve as a CDN. So please use a static CDN service. For further information on how to setup your icon with a CDN URL, please see icon guidelines. It's not as intuitive as you might hope.