Skip to content

Instantly share code, notes, and snippets.

@ferventcoder
Created December 1, 2015 16:04
Show Gist options
  • Save ferventcoder/d1b146fc8daf9166ce50 to your computer and use it in GitHub Desktop.
Save ferventcoder/d1b146fc8daf9166ce50 to your computer and use it in GitHub Desktop.
Here's an example of the package validator in action. It's validating a package that has been submitted.
Requirements

When a package version has failed requirements, the package version requires fixing or response by the maintainer. If items are flagged correctly, they must be fixed before the package version can be approved. The exact same version should be uploaded during moderation review.

  • If you are going to fill in copyright, please use more than 4 characters.
  • Tags (tags) are space separated values for referencing categories for software. Please don't use comma to separate tags.
Guidelines

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.

  • The nuspec has been enhanced to allow you to put in packageSourceUrl, pointing to the url where this package source resides. Consider adding it to the nuspec.
  • Description should be sufficient to explain the software. Please fill in the description with more information about the software. Feel free to use use markdown.
  • Title (title) is missing. Please consider including title in the nuspec.
  • Summary (summary) is a short explanation of the software. Please include summary in the nuspec.
Suggestions

Suggestions are newly introduced items that should be considered. A package version can be approved without addressing suggestion comments.

  • The nuspec has been enhanced to allow you to put in more information related to the software. Please consider adding one or more of the following to the nuspec, if available:
    • 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
    • projectSourceUrl - points to the location of the underlying software source
@ferventcoder
Copy link
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment