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