1# How to Contribute 2 3Want to contribute? Great! First, read this page (including the small print at 4the end). 5 6## Before you contribute 7 8Before we can use your code, you must sign the [Google Individual Contributor 9License Agreement](https://developers.google.com/open-source/cla/individual?csw=1) 10(CLA), which you can do online. The CLA is necessary mainly because you own the 11copyright to your changes, even after your contribution becomes part of our 12codebase, so we need your permission to use and distribute your code. We also 13need to be sure of various other things—for instance that you'll tell us if you 14know that your code infringes on other people's patents. You don't have to sign 15the CLA until after you've submitted your code for review and a member has 16approved it, but you must do it before we can put your code into our codebase. 17Before you start working on a larger contribution, you should get in touch with 18us first through the issue tracker with your idea so that we can help out and 19possibly guide you. Coordinating up front makes it much easier to avoid 20frustration later on. 21 22## Code reviews 23 24All submissions, including submissions by project members, require review. We 25use Github pull requests for this purpose. 26 27## YAPF coding style 28 29YAPF follows the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) 30with two exceptions: 31 32- 2 spaces for indentation rather than 4. 33- CamelCase for function and method names rather than `snake_case`. 34 35The rationale for this is that YAPF was initially developed at Google where 36these two exceptions are still part of the internal Python style guide. 37 38## Getting started 39YAPF supports using tox 3 for creating a local dev environment, testing, and 40building redistributables. See [HACKING.md](HACKING.md) for more info. 41 42```bash 43$ pipx run --spec='tox<4' tox --devenv .venv 44``` 45 46## Small print 47 48Contributions made by corporations are covered by a different agreement than 49the one above, the Software Grant and Corporate Contributor License Agreement. 50