Skip to content

Submitting a pull request

Brett Cannon edited this page Feb 7, 2022 · 6 revisions

Contributor License Agreement

Before we can accept a pull request from you, you'll need to sign a Contributor License Agreement (CLA). This is a one-time requirement for Microsoft projects in GitHub. You can read more about Contribution License Agreements on Wikipedia.

However, you don't have to do this up-front. You can simply clone, fork, and submit your pull-request as usual.

When your pull-request is created, it is checked by a CLA bot, which will tell you how to sign a CLA if necessary. Once you have signed it, all future pull-requests will not require you to sign a new CLA.

Creating a pull request

To enable us to quickly review and accept your pull requests, always open one pull request per issue and link the issue in the pull request description. If there is no preexisting issue for your pull request, go ahead and create one. Do note that if you do not discuss how you plan to solve the issue you do run the risk of us rejecting your PR over design considerations.

Be sure to follow our coding guidelines and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible.

Last but not least, add a news entry to your pull request with a one-line description of the change you are introducing. We use these news entries to populate our changelog, so remember to thank yourself for your time and contribution.

There are pull request status checks that try to enforce some of this, so please make sure your pull request passes all checks.

Clone this wiki locally