• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Want to contribute? Great! First, read this page (including the small print at the end).
2
3Before you contribute
4---------------------
5
6Before we can use your code, you must sign the `Google Individual Contributor
7License Agreement
8<https://developers.google.com/open-source/cla/individual?csw=1>`_ (CLA), which
9you can do online. The CLA is necessary mainly because you own the
10copyright to your changes, even after your contribution becomes part of our
11codebase, so we need your permission to use and distribute your code. We also
12need to be sure of various other things—for instance that you'll tell us if you
13know that your code infringes on other people's patents. You don't have to sign
14the CLA until after you've submitted your code for review and a member has
15approved it, but you must do it before we can put your code into our codebase.
16Before you start working on a larger contribution, you should get in touch with
17us first through the issue tracker with your idea so that we can help out and
18possibly guide you. Coordinating up front makes it much easier to avoid
19frustration later on.
20
21Code reviews
22------------
23
24All submissions, including submissions by project members, require review. We
25use Github pull requests for this purpose.
26
27YAPF coding style
28-----------------
29
30YAPF follows the `Chromium Python Style Guide
31<https://www.chromium.org/chromium-os/python-style-guidelines>`_. It's the same
32as the Google Python Style guide with two exceptions:
33
34- 2 spaces for indentation rather than 4.
35- CamelCase for function and method names rather than words_with_underscores.
36
37The rationale for this is that YAPF was initially developed at Google where
38these two exceptions are still part of the internal Python style guide.
39
40Small print
41-----------
42
43Contributions made by corporations are covered by a different agreement than
44the one above, the Software Grant and Corporate Contributor License Agreement.
45