Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 1 | Short Version: |
| 2 | |
| 3 | - Make small logical changes. |
| 4 | - Provide a meaningful commit message. |
| 5 | - Make sure all code is under the Apache License, 2.0. |
J. Lewis Muir | 0727947 | 2018-01-11 12:21:25 -0600 | [diff] [blame] | 6 | - Make sure all commit messages have a Change-Id. |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 7 | - Publish your changes for review: |
| 8 | |
Shawn O. Pearce | 58874c0 | 2012-03-23 16:34:20 -0700 | [diff] [blame] | 9 | git push https://gerrit.googlesource.com/gerrit HEAD:refs/for/master |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 10 | |
| 11 | |
| 12 | Long Version: |
| 13 | |
| 14 | I wanted a file describing how to submit patches for Gerrit, |
| 15 | so I started with the one found in the core Git distribution |
| 16 | (Documentation/SubmittingPatches), which itself was based on the |
| 17 | patch submission guidelines for the Linux kernel. |
| 18 | |
| 19 | However there are some differences, so please review and familiarize |
| 20 | yourself with the following relevant bits: |
| 21 | |
| 22 | |
| 23 | (1) Make separate commits for logically separate changes. |
| 24 | |
| 25 | Unless your patch is really trivial, you should not be sending |
| 26 | out a patch that was generated between your working tree and your |
| 27 | commit head. Instead, always make a commit with complete commit |
| 28 | message and generate a series of patches from your repository. |
| 29 | It is a good discipline. |
| 30 | |
| 31 | Describe the technical detail of the change(s). |
| 32 | |
| 33 | If your description starts to get too long, that's a sign that you |
| 34 | probably need to split up your commit to finer grained pieces. |
| 35 | |
| 36 | |
| 37 | (2) Check the license |
| 38 | |
| 39 | Gerrit Code Review is licensed under the Apache License, 2.0. |
| 40 | |
| 41 | Because of this licensing model *every* file within the project |
| 42 | *must* list the license that covers it in the header of the file. |
| 43 | Any new contributions to an existing file *must* be submitted under |
| 44 | the current license of that file. Any new files *must* clearly |
| 45 | indicate which license they are provided under in the file header. |
| 46 | |
| 47 | Please verify that you are legally allowed and willing to submit your |
| 48 | changes under the license covering each file *prior* to submitting |
| 49 | your patch. It is virtually impossible to remove a patch once it |
| 50 | has been applied and pushed out. |
| 51 | |
| 52 | |
| 53 | (3) Sending your patches. |
| 54 | |
| 55 | Do not email your patches to anyone. |
| 56 | |
| 57 | Instead, login to the Gerrit Code Review tool at: |
| 58 | |
Shawn O. Pearce | 5476551 | 2012-02-13 18:53:49 -0800 | [diff] [blame] | 59 | https://gerrit-review.googlesource.com/ |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 60 | |
| 61 | Ensure you have completed one of the necessary contributor |
| 62 | agreements, providing documentation to the project maintainers that |
| 63 | they have right to redistribute your work under the Apache License: |
| 64 | |
Shawn O. Pearce | 5476551 | 2012-02-13 18:53:49 -0800 | [diff] [blame] | 65 | https://gerrit-review.googlesource.com/#/settings/agreements |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 66 | |
Shawn O. Pearce | 5476551 | 2012-02-13 18:53:49 -0800 | [diff] [blame] | 67 | Ensure you have obtained a unique HTTP password to identify yourself: |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 68 | |
Shawn O. Pearce | 5476551 | 2012-02-13 18:53:49 -0800 | [diff] [blame] | 69 | https://gerrit-review.googlesource.com/#/settings/http-password |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 70 | |
J. Lewis Muir | 0727947 | 2018-01-11 12:21:25 -0600 | [diff] [blame] | 71 | Ensure you have installed the commit-msg hook that automatically |
| 72 | generates and inserts a Change-Id line during "git commit". This can |
| 73 | be done from the root directory of the local Git repository: |
| 74 | |
| 75 | curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg |
| 76 | chmod +x .git/hooks/commit-msg |
| 77 | |
Shawn O. Pearce | 5476551 | 2012-02-13 18:53:49 -0800 | [diff] [blame] | 78 | Push your patches over HTTPS to the review server, possibly through |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 79 | a remembered remote to make this easier in the future: |
| 80 | |
Shawn O. Pearce | 58874c0 | 2012-03-23 16:34:20 -0700 | [diff] [blame] | 81 | git config remote.review.url https://gerrit.googlesource.com/gerrit |
Shawn O. Pearce | 13a72f2 | 2009-07-02 13:45:52 -0700 | [diff] [blame] | 82 | git config remote.review.push HEAD:refs/for/master |
| 83 | |
| 84 | git push review |
| 85 | |
| 86 | You will be automatically emailed a copy of your commits, and any |
| 87 | comments made by the project maintainers. |