• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Want to contribute? Great! First, read this page (including the small print at the end).
2
3### Before you contribute
4Before we can use your code, you must sign the
5[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
6(CLA), which you can do online. The CLA is necessary mainly because you own the
7copyright to your changes, even after your contribution becomes part of our
8codebase, so we need your permission to use and distribute your code. We also
9need to be sure of various other things—for instance that you'll tell us if you
10know that your code infringes on other people's patents. You don't have to sign
11the CLA until after you've submitted your code for review and a member has
12approved it, but you must do it before we can put your code into our codebase.
13Before you start working on a larger contribution, you should get in touch with
14us first via email with your idea so that we can help out and possibly guide
15you. Coordinating up front makes it much easier to avoid frustration later on.
16
17### Code reviews
18All submissions, including submissions by project members, require review. We
19use [Gerrit](https://boringssl-review.googlesource.com) for this purpose.
20
21#### Setup
22If you have not done so on this machine, you will need to set up a password for
23Gerrit. Sign in with a Google account, visit
24[this link](https://boringssl.googlesource.com/), and click the "Generate
25Password" link in the top right. You will also need to prepare your checkout to
26[add Change-Ids](https://gerrit-review.googlesource.com/Documentation/cmd-hook-commit-msg.html)
27on commit. Run:
28
29    curl -Lo .git/hooks/commit-msg https://boringssl-review.googlesource.com/tools/hooks/commit-msg
30    chmod u+x .git/hooks/commit-msg
31
32#### Uploading changes
33To upload a change, push it to the special `refs/for/master` target:
34
35    git push origin HEAD:refs/for/master
36
37The output will then give you a link to the change. Add `agl@google.com` and
38`davidben@google.com` as reviewers.
39
40Pushing a commit with the same Change-Id as an existing change will upload a new
41version of it. (Use the `git rebase` or `git commit --amend` commands.)
42
43For more detailed instructions, see the
44[Gerrit User Guide](https://gerrit-review.googlesource.com/Documentation/intro-user.html).
45
46### The small print
47Contributions made by corporations are covered by a different agreement than
48the one above, the
49[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).
50