Benoit Jacob | 75c4ec0 | 2015-06-25 15:50:59 -0400 | [diff] [blame] | 1 | Want to contribute? Great! First, read this page (including the small print at the end). |
| 2 | |
Miao Wang | 7b05d57 | 2015-10-19 15:30:10 -0700 | [diff] [blame] | 3 | |
Benoit Jacob | 75c4ec0 | 2015-06-25 15:50:59 -0400 | [diff] [blame] | 4 | Before you contribute |
| 5 | ===================== |
| 6 | |
| 7 | Before we can use your code, you must sign the Google Individual Contributor |
| 8 | License Agreement (CLA), |
| 9 | |
| 10 | https://developers.google.com/open-source/cla/individual?csw=1 |
| 11 | |
| 12 | which you can do online. The CLA is necessary mainly because you own the |
| 13 | copyright to your changes, even after your contribution becomes part of our |
| 14 | codebase, so we need your permission to use and distribute your code. We also |
| 15 | need to be sure of various other things—for instance that you'll tell us if you |
| 16 | know that your code infringes on other people's patents. You don't have to sign |
| 17 | the CLA until after you've submitted your code for review and a member has |
| 18 | approved it, but you must do it before we can put your code into our codebase. |
| 19 | Before you start working on a larger contribution, you should get in touch with |
| 20 | us first through the issue tracker with your idea so that we can help out and |
| 21 | possibly guide you. Coordinating up front makes it much easier to avoid |
| 22 | frustration later on. |
| 23 | |
Miao Wang | 7b05d57 | 2015-10-19 15:30:10 -0700 | [diff] [blame] | 24 | |
| 25 | Getting in touch with the gemmlowp community |
| 26 | ============================================ |
| 27 | |
| 28 | The central point of communication around gemmlowp is the mailing list, |
| 29 | https://groups.google.com/forum/#!forum/gemmlowp |
| 30 | |
| 31 | |
| 32 | TODO items and projects |
| 33 | ======================= |
| 34 | |
| 35 | We try to keep a current list of TODO items in the todo/ directory. |
| 36 | Please feel free to pick one to work on, and to ask current maintainers for |
| 37 | guidance. The gemmlowp mailing list is a good place for that. |
| 38 | |
| 39 | |
Benoit Jacob | 75c4ec0 | 2015-06-25 15:50:59 -0400 | [diff] [blame] | 40 | Code reviews |
| 41 | ============ |
| 42 | |
Miao Wang | 7b05d57 | 2015-10-19 15:30:10 -0700 | [diff] [blame] | 43 | All submissions, including submissions by project members, require review. |
| 44 | For this purpose, we use Github pull requests against this repository: |
| 45 | |
| 46 | https://github.com/google/gemmlowp |
| 47 | |
Benoit Jacob | 75c4ec0 | 2015-06-25 15:50:59 -0400 | [diff] [blame] | 48 | |
| 49 | The small print |
| 50 | =============== |
| 51 | |
| 52 | Contributions made by corporations are covered by a different agreement than |
| 53 | the one above, the Software Grant and Corporate Contributor License Agreement. |