| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 1 | # Gerrit Code Review |
| 2 | |
| 3 | [Gerrit](https://www.gerritcodereview.com) is a code review and project |
| 4 | management tool for Git based projects. |
| 5 | |
| 6 | ## Objective |
| 7 | |
| 8 | Gerrit makes reviews easier by showing changes in a side-by-side display, |
| 9 | and allowing inline comments to be added by any reviewer. |
| 10 | |
| 11 | Gerrit simplifies Git based project maintainership by permitting any |
| 12 | authorized user to submit changes to the master Git repository, rather |
| 13 | than requiring all approved changes to be merged in by hand by the project |
| 14 | maintainer. |
| 15 | |
| 16 | ## Documentation |
| 17 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 18 | For information about how to install and use Gerrit, refer to |
| 19 | [the documentation](https://gerrit-review.googlesource.com/Documentation/index.html). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 20 | |
| 21 | ## Source |
| 22 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 23 | Our canonical Git repository is located on [googlesource.com](https://gerrit.googlesource.com/gerrit). |
| 24 | There is a mirror of the repository on [Github](https://github.com/gerrit-review/gerrit). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 25 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 26 | ## Reporting bugs |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 27 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 28 | Please report bugs on the [issue tracker](https://code.google.com/p/gerrit/issues/list). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 29 | |
| 30 | ## Contribute |
| 31 | |
| 32 | Gerrit is the work of hundreds of contributors. We appreciate your help! |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 33 | |
| 34 | Please read the [contribution guidelines](https://gerrit.googlesource.com/gerrit/+/master/SUBMITTING_PATCHES). |
| 35 | |
| 36 | Note that we do not accept Pull Requests via the Github mirror. |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 37 | |
| 38 | ## Getting in contact |
| 39 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 40 | The IRC channel on freenode is #gerrit. An archive is available at: |
| 41 | [echelog.com](http://echelog.com/logs/browse/gerrit). |
| 42 | |
| 43 | The Developer Mailing list is [repo-discuss on Google Groups](https://groups.google.com/forum/#!forum/repo-discuss). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 44 | |
| 45 | ## License |
| 46 | |
| 47 | Gerrit is provided under the Apache License 2.0. |
| 48 | |
| 49 | ## Build |
| 50 | |
| 51 | Install [Buck](http://facebook.github.io/buck/setup/install.html) and run the following: |
| 52 | |
| 53 | git clone --recursive https://gerrit.googlesource.com/gerrit |
| David Ostrovsky | 0a79f35 | 2015-11-02 08:40:38 +0100 | [diff] [blame] | 54 | cd gerrit && buck build release |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 55 | |
| 56 | ## Install binary packages (Deb/Rpm) |
| 57 | |
| 58 | The instruction how to configure GerritForge/BinTray repositories is |
| 59 | [here](http://gitenterprise.me/2015/02/27/gerrit-2-10-rpm-and-debian-packages-available) |
| 60 | |
| 61 | On Debian/Ubuntu run: |
| 62 | |
| 63 | apt-get update & apt-get install gerrit=<version>-<release> |
| 64 | |
| 65 | _NOTE: release is a counter that starts with 1 and indicates the number of packages that have |
| 66 | been released with the same version of the software._ |
| 67 | |
| 68 | On CentOS/RedHat run: |
| 69 | |
| 70 | yum clean all && yum install gerrit-<version>[-<release>] |
| 71 | |
| 72 | _NOTE: release is optional. Last released package of the version is installed if the release |
| 73 | number is omitted._ |
