Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 1 | Short Version: |
| 2 | |
| 3 | - Make small logical changes. |
| 4 | - Provide a meaningful commit message. |
David Pursehouse | 4f7bdea | 2012-10-22 12:50:15 +0900 | [diff] [blame] | 5 | - Check for coding errors with pylint |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 6 | - Make sure all code is under the Apache License, 2.0. |
| 7 | - Publish your changes for review: |
| 8 | |
David Pursehouse | a43f42f | 2012-08-21 16:26:07 +0900 | [diff] [blame] | 9 | git push https://gerrit-review.googlesource.com/git-repo HEAD:refs/for/master |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 10 | |
| 11 | |
| 12 | Long Version: |
| 13 | |
| 14 | I wanted a file describing how to submit patches for repo, |
| 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 | |
David Pursehouse | 4f7bdea | 2012-10-22 12:50:15 +0900 | [diff] [blame] | 37 | (2) Check for coding errors with pylint |
| 38 | |
| 39 | Run pylint on changed modules using the provided configuration: |
| 40 | |
| 41 | pylint --rcfile=.pylintrc file.py |
| 42 | |
| 43 | |
| 44 | (3) Check the license |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 45 | |
| 46 | repo is licensed under the Apache License, 2.0. |
| 47 | |
| 48 | Because of this licensing model *every* file within the project |
| 49 | *must* list the license that covers it in the header of the file. |
| 50 | Any new contributions to an existing file *must* be submitted under |
| 51 | the current license of that file. Any new files *must* clearly |
| 52 | indicate which license they are provided under in the file header. |
| 53 | |
| 54 | Please verify that you are legally allowed and willing to submit your |
| 55 | changes under the license covering each file *prior* to submitting |
| 56 | your patch. It is virtually impossible to remove a patch once it |
| 57 | has been applied and pushed out. |
| 58 | |
| 59 | |
David Pursehouse | 4f7bdea | 2012-10-22 12:50:15 +0900 | [diff] [blame] | 60 | (4) Sending your patches. |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 61 | |
| 62 | Do not email your patches to anyone. |
| 63 | |
| 64 | Instead, login to the Gerrit Code Review tool at: |
| 65 | |
Shawn O. Pearce | 9b017da | 2012-02-28 18:53:12 -0800 | [diff] [blame] | 66 | https://gerrit-review.googlesource.com/ |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 67 | |
| 68 | Ensure you have completed one of the necessary contributor |
| 69 | agreements, providing documentation to the project maintainers that |
| 70 | they have right to redistribute your work under the Apache License: |
| 71 | |
Shawn O. Pearce | 9b017da | 2012-02-28 18:53:12 -0800 | [diff] [blame] | 72 | https://gerrit-review.googlesource.com/#/settings/agreements |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 73 | |
Shawn O. Pearce | 9b017da | 2012-02-28 18:53:12 -0800 | [diff] [blame] | 74 | Ensure you have obtained an HTTP password to authenticate: |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 75 | |
Shawn O. Pearce | 9b017da | 2012-02-28 18:53:12 -0800 | [diff] [blame] | 76 | https://gerrit-review.googlesource.com/new-password |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 77 | |
Shawn O. Pearce | 9b017da | 2012-02-28 18:53:12 -0800 | [diff] [blame] | 78 | Push your patches over HTTPS to the review server, possibly through |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 79 | a remembered remote to make this easier in the future: |
| 80 | |
Shawn O. Pearce | 9b017da | 2012-02-28 18:53:12 -0800 | [diff] [blame] | 81 | git config remote.review.url https://gerrit-review.googlesource.com/git-repo |
David Pursehouse | a43f42f | 2012-08-21 16:26:07 +0900 | [diff] [blame] | 82 | git config remote.review.push HEAD:refs/for/master |
Shawn O. Pearce | 2d1a396 | 2009-07-02 13:18:42 -0700 | [diff] [blame] | 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. |