Ben Vanik | 363fa07 | 2019-09-19 10:26:25 -0700 | [diff] [blame] | 1 | # How to Contribute |
| 2 | |
| 3 | We'd love to accept your patches and contributions to this project. There are |
| 4 | just a few small guidelines you need to follow. |
| 5 | |
| 6 | ## Contributor License Agreement |
| 7 | |
| 8 | Contributions to this project must be accompanied by a Contributor License |
| 9 | Agreement. You (or your employer) retain the copyright to your contribution; |
| 10 | this simply gives us permission to use and redistribute your contributions as |
| 11 | part of the project. Head over to <https://cla.developers.google.com/> to see |
| 12 | your current agreements on file or to sign a new one. |
| 13 | |
| 14 | You generally only need to submit a CLA once, so if you've already submitted one |
| 15 | (even if it was for a different project), you probably don't need to do it |
| 16 | again. |
| 17 | |
Ben Vanik | 850152b | 2019-09-25 15:53:03 -0700 | [diff] [blame] | 18 | ## Changes Accepted |
| 19 | |
| 20 | Please file issues before doing substantial work; this will ensure that others |
| 21 | don't duplicate the work and that there's a chance to discuss any design issues. |
| 22 | |
| 23 | Changes only tweaking style are unlikely to be accepted unless they are applied |
| 24 | consistently across the project. Most of the code style is derived from the |
| 25 | [Google Style Guides](http://google.github.io/styleguide/) for the appropriate |
| 26 | language and is generally not something we accept changes on (as clang-format |
| 27 | and clang-tidy handle that for us). Improvements to code structure and clarity |
| 28 | are welcome but please file issues to track such work first. |
| 29 | |
Ben Vanik | 363fa07 | 2019-09-19 10:26:25 -0700 | [diff] [blame] | 30 | ## Code reviews |
| 31 | |
| 32 | All submissions, including submissions by project members, require review. We |
| 33 | use GitHub pull requests for this purpose. Consult |
| 34 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more |
| 35 | information on using pull requests. |
| 36 | |
| 37 | ## Community Guidelines |
| 38 | |
| 39 | This project follows |
| 40 | [Google's Open Source Community Guidelines](https://opensource.google.com/conduct/). |