Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

100 lines (64 loc) · 3.42 KB
Raw

Contributing

Prerequisites

  • Visual Studio 2019 with following workloads:
    • .NET Core Cross Platform Development
    • .NET desktop development
    • Visual Studio extension development.
    • Desktop development with C++
  • Windows 10 SDK
  • Git
  • Windows Powershell v3.0+

Note that you can work on the NuGet.Client repo with Visual Studio 2017, but you will be unable to test the Visual Studio extension.

Contributing step-by-step

  1. Open an issue here and get some feedback from the NuGet team.
  2. Follow the instructions in Code
  3. Make your change, and add tests.
  4. Create a pull request.
  5. 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.
  6. Submit a doc pull request to the docs.microsoft-com.nuget repo, if this is a new feature or behavior change.

Code

The way non-NuGet members contribute to this repository is via the fork model. Contributors push changes to their own "forked" version of NuGet.Client, and then submit a pull request into it requesting those changes be merged.

To get started:

  1. Fork the repo.

  2. From a git enable terminal, run (replacing [user-name] with your GitHub user name):

\> git clone https://github.com/[user-name]/NuGet.Client
\> cd NuGet.Client
\NuGet.Client> git remote add upstream https://github.com/NuGet/NuGet.Client
\NuGet.Client> git remote set-url --push upstream no_push

After running above, git remote -v should show something similar to the following:

\NuGet.Client> git remote -v

origin  https://github.com/[user-name]/NuGet.Client (fetch)
origin  https://github.com/[user-name]/NuGet.Client (push)
upstream        https://github.com/NuGet/NuGet.Client (fetch)
upstream        no_push (push)

NuGet team members

NuGet members may contribute directly to the main remote.

Build

  1. Clone the NuGet.Client repository.

  2. Start PowerShell. CD into the cloned repository directory.

  3. Run the configuration script

    .\configure.ps1

  4. Build with

    .\build.ps1 -SkipUnitTest

    Or Build and Unit test with

    .\build.ps1

    Note: You have to to run .\configure.ps1 and .\build.ps1 at least once in order for your build to succeed.

  5. Run unit and functional tests if inside Microsoft corpnet with

    .\runTests.ps1

In case you have build issues try cleaning the local repository using git clean -xdf and retry steps 3 and 4.

Notable build.ps1 switches

  • -SkipUnitTest - skips running unit tests.
  • -Fast - runs minimal incremental build. Skips end-to-end packaging step.

Reveal all script parameters and switches by running Get-Help .\build.ps1 -detailed

Build artifacts location

  • $(NuGetClientRoot)\artifacts\VS15 - this folder will contain the Package Manager extension (NuGet.Tools.vsix) and NuGet command-line client application (NuGet.exe)
  • $(NuGetClientRoot)\artifacts\nupkgs - this folder will contain all our projects packages

Resources for NuGet.Client development