What should I do for getting started ?
- Sign In with your GitHub username and password
- Allow GerritHub accessing your profile
- Select the SSH Public Keys you want to import
- Select the Git repositories you want to use
Why you need to login using GitHub ?
GerritHub and GitHub work together to give you Code Review on your existing repositories: your identity on Gerrit is synchronized with your GitHub identity.
Why GerritHub requires write permissions ?
GerritHub needs a user:email+public_repo scopes when authenticating with the GitHub API: the only information read from your profile are your full name, e-mail and SSH public keys: we do NOT write any information to your GitHub profile or followers or share with any other service on-line.
When start using GerritHub, your Git commits and patches for review will be mirrored back to GitHub thanks to Gerrit replication mechanism. GerritHub pushes on your behalf your reviewed commits to your GitHub repositories.
In order to get the replication work properly, you should push to Gerrit and use your GitHub repository for pull and pull-requests only. If you keep on pushing directly to GitHub you would cause the Gerrit replication process to stop: this is done for avoiding to overwrite the GitHub history because of the potential conflicts.
How can I resume replication to GitHub ?
If you pushed directly on GitHub, in order to allow Gerrit catching-up with the new commits on GitHub follow the steps below:
- Clone the repository from Gerrit (git clone <GerritHub URL> master)
- Pull and merge the latest GitHub changes (git pull <GitHub URL> master)
- Push the merged branch to Gerrit (git push <GerritHub URL> master)