Contributing to NuGet
Clone this wiki locally
So you want to contribute to NuGet. Great! We can use the help and appreciate the help!
Ways to Contribute
While writing code is certainly glamorous and gets all the attention, it's not the only way to contribute to NuGet. In many cases, it's not even the most valuable way to contribute. If you would like to contribute to NuGet to help the project along, consider these options (which are valid for any OSS project, not just NuGet):
- Improve our documentation. Documentation often gets little love and attention in an Open Source project, but those who help with documentation receive tremendous love and kudos from the team.
- Submit a bug report (for an excellent guide on submitting good bug reports, read Painless Bug Tracking).
- Submit a feature request.
- Help verify submitted fixes for bugs.
- Help answer questions in the discussions list.
- Submit a unit test to help provide code coverage.
- Tell others about the project.
- Tell the developers how much you appreciate the product!
Contributing code refers to making a contribution to the source code for NuGet itself and does not pertain to adding packages to a NuGet feed.
Miguel de Icaza has a good post on Open Source Contribution Etiquette that is worth reading, as the guidance he gives applies well to NuGet.
The first order of business is to get yourself familiar with the product (and depending on the type of contribution you wish to make, the code).
- Subscribe to the NuGet and NuGet Gallery Issue Tracker by making sure you have a GitHub.com account and turning on notifications by clicking the Watch button.
- Download the latest release and try the product out.
- Read up on the docs at docs.nuget.org.
- Get your development environment set up.
- If you plan to make large submissions (anything larger than a small bug fix or feature), set up your environment for code reviews.
- Familiarize yourself with the source code. Make sure you can build it.
- Consider answering questions in the discussion list, to build on your understanding of the code.
- Familiarize yourself with the project guidelines and our coding conventions. Following the coding conventions is very important to us as we're very picky about them out of necessity in order to maintain consistency. We know that sometimes, people will make a small mistake here and there and if it's a really nitpicky thing, we'll accept the pull request anyways and just fix the code ourselves.
Contributing a Bug Fix or Feature
Now that you've read through our Getting Started section above and have set up your development environment accordingly, you're ready to start contributing code! Please follow the following steps each time you take on a feature or bug fix. Note that some of these steps are unnecessary for small changes.
- Decide what feature or bug fix you plan to take on and start a discussion with the title of the bug so we know someone is already working on it. e.g. "I'm going to fix issue 59: Something's Broken." If you're just starting out, pick something small to fix such as:
- Add a missing unit test
- Fix an FxCop issue
- Search for a // TODO comment in the code and address one
- Fix a defect in the issue list (do a search for “UpForGrabs” or just find one with the “Proposed” status). Try something small first and work your way up to larger issues
- Create a server-side Fork of the NuGet project in CodePlex.
Navigate to the Source Code tab and click Create Fork to create the remote clone of the main repository.
- Clone the fork you created in the previous step to your machine.
- Run build.cmd from the command line to ensure packages are restored.
- Make the relevant changes in your local clone (potentially adding a unit test if this is a bug fix).
- Run build.cmd from the command line and make sure that there are 0 errors.
- Commit your changes in your local clone. You may end up repeating steps 4-6 multiple times as you work. When you are finished and ready to have us accept your change, go to step 7.
- Pull from Main and merge your changes with the latest from Main (fix any merge conflicts you might have).
- Send a pull request and make sure the summary contains relevant bug numbers and a good description of your changes.
- If you need to revise your code, then do so locally and update the review. Repeat until we approve the review.
- Wait for your review to be approved. We'll try to get to it as soon as possible.
- Push to your server fork and send a pull request. Note, you can push to your server fork at any time if you want to backup your code on the server, but don't send the pull request until your review is approved.
If you're contributing a new non-trivial feature, we will ask you to fill out a Contributor License Agreement form before we merge your change into the core. It doesn't take long and you can email us the form. There's no need to deal with stamps and sending anything over snail mail.
Please only contribute code which you wrote or have the rights to contribute. Do not contribute GPL code as our code is licensed under the Apache 2 license.