Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 3.05 KB
Raw

How to become a contributor and submit your own code

Patches are always welcome!

If you're interested in contributing a new code sample or making large changes to existing samples, please open an issue for discussion first.

Contributing A Patch

  1. Submit an issue describing your proposed change to this repository.
  2. A repo owner will respond to your issue promptly. If you don't see a response within a few days, please ping the owner assignd to your issue.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork this repo, develop and test your code changes. Tests are required for all samples. See the Authoring Guide for details.
  5. Ensure that your code adheres to the existing style in the sample to which you are contributing.
  6. Ensure that your code has an appropriate set of unit tests which all pass.
  7. Submit a pull request.

Contributor License Agreements

Before we can take contributions, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

Setting up a development environment

Authoring, testing, and contributing samples

See AUTHORING_GUIDE.md.

Code Reviews

After meeting the above criteria, your code will need to be approved by two reviewers before it can be merged into main. One will be a CODEOWNER for the product you are contributing to, and the other will be a repo owner, there to double check for anything that might be detrimental to the overall repo health (things that could cause future tech debt, test flakiness, etc.). Both will automatically be assigned. Some product areas have mulitple folks who can act as the CODEOWNER, and you may be working more closely with a teammate who isn't the automatically assigned reviewer. In that case, it is perfectly fine to manually assign the teammate more familiar with this work as your CODEOWNER reviewer. If you do not hear from your repo owner reviewer within a day (and you know they are not OOO), send them a friendly ping so that you can better understand the review cadence for your PR. All the repo owners are juggling reviews alongside other work, and their velocities can vary, but they are happy to hear from you. If you see that your repo owner reviewer is OOO, you can use the "blunderbuss: assign" label to assign a new reviewer.