Gerrit/Getting started

From MediaWiki.org
< Gerrit(Redirected from Git/TLDR)
Jump to: navigation, search

This is a very short guide to using Git and Gerrit for MediaWiki development. For a more thorough guide, see Gerrit/Tutorial.

Get the code:

git clone ssh://<username>@gerrit.wikimedia.org:29418/mediawiki/core.git or
git clone ssh://<username>@gerrit.wikimedia.org:29418/mediawiki/extensions/<extension>.git

Write and send new code:

git checkout master
git pull --rebase
git checkout -b <meaningful-branch-name> # Branch naming tips are available.
# Now write some code. See the Git commands "add", "rm" and "mv" to add, remove or rename files. When you're ready:
git commit --all # In the Gerrit world you can do this only once per branch! Remember to follow the commit message guidelines.
git show HEAD # Make sure that you are sending what you wanted to send. Press q to quit.
git fetch --all # Make sure git-review is aware of recent changes on gerrit.
git review

Go to Gerrit, click your change and write a reviewer name in the input box near the "Add Reviewer" button. If you don't know who to invite, try the maintainer for the component you've edited, or ask on IRC (#wikimedia-devconnect).

If the reviewer asks you to make a change, make it and amend your commit:

git checkout master
git pull --rebase
git review --download <change ID> # e.g. 1234 in gerrit.wikimedia.org/r/1234
# Make the needed changes to the source files.
git commit --all --amend # You can do this more than once. You can change the commit message, but make sure to leave the "Change-Id" line intact!
git review --no-rebase # This creates a new patch set in Gerrit, and sends an invitation to review the code again.

To test or otherwise work with other people's code, just follow the same steps to amend a change described above, using the corresponding <change ID>.

For more complex tasks and workflows, see Gerrit/Advanced usage. Also, consider testing your code before submitting.