Gerrit/Tutoriel/Abrégé

Ceci est un guide de style tl;dr destiné aux développeurs qui ont déjà une expérience avec Git et qui souhaitent aborder Gerrit pour les développements MediaWiki. Pour un tutoriel comprenant les explications détaillées, voir plutôt Gerrit/Tutoriel .

Prérequis

1. Installer Git et git-review .
2. Créer une nouvelle clé SSH à utiliser avec Gerrit Wikimedia :
   • Exécutez ceci à partir de votre terminal en substituant votre adresse courriel :

     ssh-keygen -t ed25519 -C "your_email@example.com"

   • A l'invite "Enter a file in which to save the key", vous pouvez appuyer sur Entrée et accepter les valeurs par défaut s'il s'agit de votre première clé SSH. Sinon modifiez-la pour qu'elle soit similaire à /Users/YOUR_NAME/.ssh/id_wikimedia_gerrit
   • A l'invite "Enter passphrase:", choisissez une phrase secrète assez forte. Typiquement vous devrez le faire le jour où pour la première fois, vous publierez ou enverrez vos demandes de modification.
3. Créer un compte développeur Wikimedia. Ensuite, connectez-vous à gerrit.wikimedia.org et ajoutez votre clé publique à votre compte. La clé publique est le contenu de /Users/you/.ssh/id_wikimedia_gerrit.pub
4. Configurer Git pour définir votre adresse courriel, votre nom et le nom d'utilisateur SSH.

Obtenir le code

Recopiez le dépôt en utilisant la commande du navigateur (par exemple https://gerrit.wikimedia.org/g/mediawiki/core). Vous pouvez trouver ces dépôts dans la liste, ou à partir de la boîte d'information de l'extension sur mediawiki.org. Les dépôts le plus souvent recopiés sont :

Noyau MediaWiki : git clone https://gerrit.wikimedia.org/r/mediawiki/core.git mediawiki

Extensions MediaWiki : git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/<extension>.git

Habillages MediaWiki : git clone https://gerrit.wikimedia.org/r/mediawiki/skins/<habillage>.git

Ecrire votre correction

Commencez votre branche à partir du master le plus récent :

mediawiki$ git checkout master
mediawiki$ git pull
mediawiki$ git checkout -b nom significatif de branche

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

Maintenant, vous pouvez éditer le code pour effectuer et tester vos modifications. Dès que vous êtes satisfait et que le code est prêt et opérationnel :

• git commit --all Dans le monde Gerrit vous ne devez faire cela qu'une fois par branche. Pour corriger les erreurs, utiliser git commit --amend.
• git show Relisez votre correction pour confirmer ce que vous nous soumettez. Pressez « q » pour quitter.
• git review Ceci propulse votre code sur Gerrit et crée une demande de modification. Si vous obtenez des erreurs et que vous avez installé précédemment l'ancien programme gerrit-tools, installez git-review en remplacement.

Nous vous encourageons à inviter un ou deux mainteneurs pour la relecture de vos modifications. Après avoir créé la demande de modification, la relecture git affichera l'URL de la demande. Vous pourrez ainsi retrouver vos modifications sur le tableau de bord de Gerrit. Sur la page des modifications, sous « Reviewers » , cliquez sur le bouton du crayon « Add Reviewer ». Entrez le nom d'un relecteur dans la boîte de saisie. Si vous ne connaissez pas de relecteur à inviter, ouvrez la liste des mainteneurs pour le composant que vous avez modifié, ou demandez-le sur IRC (#mediawiki ^connecter).

Mettre à jour vos corrections

Si le mainteneur vous demande de faire une correction, amendez votre validation ainsi :

• git review -d ID_de_la_modification par exemple 1234 dans https://gerrit.wikimedia.org/r/1234. Ceci télécharge et recopie la demande de modification à partir de Gerrit.
• Editez les fichiers source pour appliquer vos modifications.
• git commit --all --amend Vous pouvez réexécuter cela autant de fois que vous le voulez. Lorsque vous modifiez le message de validation, laissez la ligne « Change-Id » intacte.
• git review Ceci met à jour votre demande de modification dans Gerrit avec une nouvelle version de l'ensemble des patchs reflètant vos corrections, et envoie une demande de relecture du code aux relecteurs qui sont abonnés.

Voir aussi

• Efforcez-vous de suivre nos Indications concernant le message de validation.
• Voir aussi Obtenir des commentaires