NuGet/Home

Provide samples for coding against NuGet 3 codebase

Open

#2,243 opened on Mar 3, 2016

View on GitHub
 (11 comments) (7 reactions) (0 assignees)HTML (1,459 stars) (292 forks)batch import
Functionality:SDKPriority:3Type:Docshelp wanted

Description

Need to enumerate common scenarios we want to show as samples, going to take a quick stab and will keep refining as feedback comes in

  • Get latest version for a given package ID
  • Search results for a given search string
  • Download a package given ID and version (or just ID and get latest)
  • Restore a project.json
  • Restore a packages.config
  • Control package extraction mode

Would be nice to contrast samples from nuget.core with the NuGet3 codebase.

We will gladly take pull requests to https://github.com/NuGet/docs.microsoft.com-nuget as folks find good ways to port over, and of course sample projects to https://github.com/nuget/samples utilizing the new API. I'm also open to running a CI on top of the samples to ensure breaking changes are at least known, if not immediately addressed.

Contributor guide

Tech stack
csharprest api
Domain
developer experiencedocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Basic knowledge of NuGetC# programmingUnderstanding of NuGet API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue lists six specific sample scenarios to implement, such as getting latest version and restoring project.json. The existing comments may contain additional context. To contribute, one should review the NuGet 3 API documentation and any existing samples in the NuGet/samples repository. The issue also suggests running CI on samples.