Skip to content

Latest commit

 

History

History
138 lines (92 loc) · 6.07 KB

CONTRIBUTING.md

File metadata and controls

138 lines (92 loc) · 6.07 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.dotnetfoundation.org/.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.

Prerequisites

Contributing step-by-step

  1. Open an issue here and get some feedback from the NuGet team.
  2. Follow the instructions under the Code heading.
  3. Create a new branch in your local repo and make your changes.
  4. Add tests.
  5. Create a pull request.
    • Create a new issue if you cannot find an existing one NuGet/Home.
    • Keep the pull request template, and link to an issue.
    • Use a meaningful PR title, not the auto-generated title based on the branch name.
    • All PRs created by someone outside the NuGet team will be assigned the Community label, and a team member will be assigned as the PR shepherd, who will be responsible for making sure the PR gets reviewed (even if they don't review it themselves), and periodically check the PR for progress.
      • PRs from forks do not trigger CI automatically. Someone in the team needs to apply the "Approved for CI", which will build only the current commit. If changes are pushed to the branch, the "Approved for CI" label needs to be removed and re-applied.
    • If the NuGet team requests changes and the PR author does not respond within 1 month, a reminder will be added. If no action is taken within 2 months of the reminder, the PR will be closed due to inactivity.
  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. 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 enabled 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.

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

  5. Run unit and functional tests with

    .\runTests.ps1

  6. Run dotnet code formatters and correct any errors.

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

Docs generation

To update the auto-generated documentation, run the following in the repo root:

dotnet msbuild .\build\docs.proj

Updated docs will be at $(NuGetClientRoot)\docs