Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 2.54 KB
Raw

Contributing

Contributor License Agreements

We'd love to accept your patches! Before we can take them, 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.

NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests and the TensorFlow Community Guidelines for more information on contributor best practices.

Before making any changes, we recommend opening an issue (if it doesn't already exist) and discussing your proposed changes. This will let us give you advice on the proposed changes. If the changes are minor, then feel free to make them without discussion.

Code Standards

We have some standards in place to ensure that incoming code is the highest quality it can be. Before a code review can happen you should make sure that the following tests are passing locally:

  1. ./scripts/test_all.sh passes. We use TensorFlow's testing suite for our testing and be sure that any code you add follows the structure they have outlined.

  2. ./scripts/lint_all.sh passes. We use pylint to ensure that code has proper formatting and is lint free.

  3. ./scripts/format_check.sh passes. We use yapf along with clang format to ensure we have consistent formatting everywhere.

Adding Modules

If you are adding new modules, be sure to properly expose them to the user using __init__.py files and update the /scripts/import_test.py file to ensure that you are exposing them properly.