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