Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 1.83 KB

Contributing

Want to contribute? Great! Please read this page so your submission can go through smoothly.

  1. Read and sign our Contributor License Agreement (See below).
  2. Fork this repository.
  3. Write changes, tests, integration tests and documentation in your fork.
  4. Create a pull request.

Contributor License Agreement

Before we can use your code, you must sign the Google Individual Contributor License Agreement (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things — for instance that you'll tell us if you know that your code infringes on other people's patents.

Contributions made by corporations are covered by a different agreement than the one above. If you work for a company that wants to allow you to contribute your work, then you'll need to sign a Software Grant and Corporate Contributor License Agreement.

You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into the repository. Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.

Tests and Documentation

All significant changes are expected to be accompanied by at minimum unit tests. If appropriate, make the needed documentation changes. If you are making a larger change or adding a new feature please add integration tests as well.