Gerrit/Tutorial/tl;dr

Prerequisites

 * 1) [ https://docs.github.com/en/get-started/quickstart/set-up-git Install Git and configure your name and email address].
 * 2) Create a new SSH key to use with Wikimedia Gerrit:
 * 3) * Run the following from your terminal, substituting your email address: ssh-keygen -t ed25519 -C "your_email@example.com"
 * 4) * At the " " prompt, you can press Enter to accept the default if this is your first SSH key. Otherwise, customize it to something like
 * 5) * At the " " prompt, choose a strong passphrase. You will typically have to the first time on a given day when pulling or sending change requests.
 * 6) Create a Wikimedia developer account.  Then, [ https://gerrit.wikimedia.org/r/login/%2Fsettings%2F%23SSHKeys log in on gerrit.wikimedia.org] and add your public key to your account. The public key is the content of

Get the code
Clone the repository using the command in the repository browser (e.g. https://gerrit.wikimedia.org/g/mediawiki/core ). You can find these on [ https://gerrit.wikimedia.org/r/plugins/gitiles/?format=HTML the list], or from the extension infobox on mediawiki.org. The most commonly cloned repositories are:

MediaWiki core:

MediaWiki extensions:

MediaWiki skins:

Write your patch
Start your branch from the latest master:

Now you can edit the code to make and test your changes. Once you are satisfied and the code is operational ready:


 * When working with Gerrit, do this only once per branch. To fix mistakes, use.
 * Review your patch to confirm what you are submitting to us. Press "q" to quit.
 * This pushes to Gerrit and creates a change request. If you receive an error and have previously installed the older " gerrit-tools " program, install " git-review " instead.

You are encouraged to invite one or two maintainers as reviewers on your change. After creating the change request, the  will have printed the URL for you change request. You can also find [https://gerrit.wikimedia.org/r/dashboard/self your changes] through your Gerrit dashboard. On the change page, under " Reviewers ", click the " Add Reviewer " pencil button. Write a reviewer name in the input box. If you don't know who to invite for reviewing, check the maintainers list for the component you've modified, or ask on.

Update your patch
If a reviewer asks you to make changes, amend your commit as follows:


 * e.g. 1234 in https://gerrit.wikimedia.org/r/1234 . This downloads and checks out the change request from Gerrit.
 * Edit the source files to make your changes.
 * You can run this as many times as you like. When editing the commit message, leave the " Change-Id " line intact.
 * This updates your change request in Gerrit, with a new patch set version reflecting your change, and automatically notifies the subscribed reviewers.