Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.16 KB
Raw

Setup

Just open the available .sln files under src and build :) (see Building in Visual Studio below).

Build, test and run code coverage:

Windows:

build.cmd

Mac:

make

Mac support comming as soon as MSBuild ships by default with XS/Mono on Mac

Building in Visual Studio

There are two parts to the project:

  1. The build targets and tasks
  2. The NuGet package project system

Targets and tasks

Install Visual Studio 2015 (preferrable also Update 3 or later).

These can be built by just opening the NuGet.Packaging.Build.sln solution.

Alternatively, you can also build with the default configuration and platform from the command line with msbuild from a developer command prompt.

NuGet Project System

The project system is built on top of the new Visual Studio Project System also known as "CPS" (Common Project System).

There were API changes between CPS for Visual Studio 2015 and the upcoming Visual Studio 15 (code name), so at the moment, we require installing a Preview 4 or later version.

NOTE: The project system is in flux at the moment, as many artifacts will move to the authoring package under the src\Build directory.

Contributing

  1. Open an issue here and get some feedback from the NuGet team.
  2. Create a branch. Base it on the dev branch.
  3. Add unit tests (to the test project in the relevant solution).
  4. Make sure all tests pass (via Test -> Run -> All Tests, or by running build.cmd on Windows).
  5. Create a pull request.
  6. One-time: Sign the contributor license agreement, if you haven't signed it before. The .NET Foundation Bot will comment on the pull request you just created and guide you on how to sign the CLA.
  7. Consider submitting a doc pull request to the nugetdocs repo, if this is a new feature or behavior change.