Gerrit/Anleitung/tl;dr
Prerequisites
- Installiere und konfiguriere Git.
- Create a new SSH key to use with Wikimedia Gerrit:
- Run the following from your terminal, substituting your email address:
ssh-keygen -t ed25519 -C "your_email@example.com"
- At the "
Enter a file in which to save the key
" prompt, you can press Enter to accept the default if this is your first SSH key. Otherwise, customize it to something like/Users/YOUR_NAME/.ssh/id_wikimedia_gerrit
- At the "
Enter passphrase:
" prompt, choose a strong passphrase. You will typically have to the first time on a given day when pulling or sending change requests.
- Run the following from your terminal, substituting your email address:
- Erstelle ein Wikimedia-Entwicklerkonto. Then, log in on gerrit.wikimedia.org and add your public key to your account. The public key is the content of
/Users/you/.ssh/id_wikimedia_gerrit.pub
- Configure Git to set your email address, name, and SSH username.
Hole den 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 the list, or from the extension infobox on mediawiki.org. The most commonly cloned repositories are:
Für den MediaWiki-Kern: git clone https://gerrit.wikimedia.org/r/mediawiki/core.git mediawiki
Oder für eine Erweiterung: git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/<erweiterung>.git
Oder für ein Skin: git clone https://gerrit.wikimedia.org/r/mediawiki/skins/<skinname>.git
Write your patch
Start your branch from the latest production branch:
mediawiki$ git checkout master mediawiki$ git pull mediawiki$ git checkout -b meaningful-branch-name
- NOTE: In some cases, the production branch may be called "production" or "main" and require a modified checkout command such as:
mediawiki$ git checkout production
mediawiki$ git checkout main
Now you can edit the code to make and test your changes. Wenn der Code fertig ist:
git commit --all
In der Gerrit-Welt solltest du das nur einmal pro Zweig tun! To fix mistakes, usegit commit --amend
.git show
Vergewissere dich, dass du das sendest, was du senden willst. Drücke "q", um zu beenden.git review
Dadurch wird dein Code an Gerrit gesendet. Wenn du Fehler mit dem Schalter "$1" erhältst, verwendest du möglicherweise veraltete "gerrit-tools" statt "git-review".
You are encouraged to invite one or two maintainers as reviewers on your change. After creating the change request, the git review
will have printed the URL for you change request. You can also find your changes through your Gerrit dashboard.
Klicke unter "Reviewers" auf die Schaltfläche "Add Reviewer".
Schreibe den Namen eines Überprüfers in das Eingabefeld.
Wenn du nicht weißt, wen du zum Überprüfen einladen sollst, versuche es bei dem Maintainer für die Komponente, die du bearbeitet hast, oder frage auf IRC (#mediawiki connect).
Update your patch
Wenn der Prüfer dich bittet, eine Änderung vorzunehmen, nimm sie vor und ergänze deinen Commit:
git review -d ID oder URL des Patches ändern
z.B. 1234 in https://gerrit.wikimedia.org/r/1234 oder $3 This downloads and checks out the change request from Gerrit.- Nimm die erforderlichen Änderungen an den Quelldateien vor.
git commit --all --amend
Du kannst dies mehr als einmal tun. Du kannst die Commit-Nachricht ändern, achte jedoch darauf, die "Change-Id"-Zeile beizubehalten.git review
Dadurch wird ein neues Patch-Set in derselben Gerrit-Änderung erstellt und eine Einladung zur erneuten Überprüfung des Codes gesendet.
See also
- Denke daran, die Commit-Nachrichtenrichtlinien zu befolgen.
- See also Getting reviews