Comment devenir un hackeur de MediaWiki

This page is a translated version of the page How to become a MediaWiki hacker and the translation is 84% complete.
Outdated translations are marked like this.

Cet article est destiné à aider les développeurs à acquérir les aptitudes nécessaires à la contribution au développement du cœur de Mediawiki et aux extensions de MediaWiki.

La méthode principale pour commencer avec le développement dans Wikimédia est de contribuer aux projets Wikimédia qui proposent du mentorat. Une alternative sans mentorat est de corriger un bon premier bogue.

Si vous êtes un développeur expérimenté, déjà familier de l'utilisation de MediaWiki, voyez plutôt le Pôle des développeurs .

Pour d'autres façons de vous impliquer dans la communauté Wikimédia, voir Comment contribuer .

Aperçu

MediaWiki est le logiciel qui propulse Wikipédia, ses projets frères et des milliers d'autres wikis dans le monde.

Bien que MediaWiki soit écrit en langage de programmation PHP, certains outils que nous supportons sont écrits dans d'autres langages, comme les fichiers batch, les scripts shell, les makefiles et Python. Il utilise jQuery comme bibliothèque JavaScript cliente.

MediaWiki a d'abord été développé pour la plateforme LAMP[1] et fonctionne sur la plupart des systèmes d'exploitation. MediaWiki utilise principalement les serveurs de bases de données MySQL et MariaDB.[2]

Le développement se fait sur un modèle open source[3], essentiellement coordonné en-ligne, et soutenu par la Fondation Wikimedia, bien que la communauté de développeurs volontaires joue également un rôle important.

La liste de diffusion principale des développeurs est wikitech-l. Les principaux canaux IRC des développeurs sont #mediawiki connect et #wikimedia-dev connect.

  • Le code source est enregistré sous Gerrit , géré en utilisant le système de contrôle de version Git et consultable ici.[4]
  • La revue du code se fait sur Gerrit et peut être affichée ici. Suivez ce tutoriel pour configurer Git et Gerrit pour soumettre des patchs.
  • Les rapports de bogues sont soumis, et les projets sont gérés dans Phabricator et peuvent être affichés ici

Configurer son environnement de développement

You can install and develop MediaWiki on Linux, Windows, or macOS using any of the three solutions below.

La plupart des projets utilisent Git et Gerrit. Suivez le tutoriel Gerrit pour configurer votre compte de développeur. Vous pouvez ensuite aller au téléchargement de notre code, faire des modifications, les tester, et soumettre des corrections. Il existe deux manières de mettre en place votre environnement de développement : en utilisant une installation pré-configurée à partir d'une machine virtuelle (Docker ou Vagrant), ou en faisant une installation manuelle.

Environnement de développement de Docker

  • MediaWiki Docker — exécuter MediaWiki en utilisant Docker (peut être utilisé avec des hôtes Linux, Windows ou macOS).

Vous pouvez également essayer l'outil expérimental mwcli qui fournit les fonctionnalités d'orchestration de base pour les conteneurs MediaWiki Docker. With this you can easily add extensions and features to your container.

If you run it from Windows, Docker shares files between your Windows filesystem and the container filesystem. This can cause MediaWiki to be very slow if you are using WSL2 based engine, due to the poor performance of its shared directory implementation. If you have Windows Pro, you can switch to the Hyper-V backend in the settings of Docker Desktop for better filesystem performance.

An even faster way to run MediaWiki using Docker in Windows (speeds comparable to manually installing) is to clone MediaWiki and run Docker inside WSL (or install and run mwcli inside of WSL). That way there is no shared filesystem overhead. To develop the MediaWiki codebase that is inside the Docker container you can establish a remote connection to it and open the MediaWiki WSL folder in that is in the container using VSCode or PhpStorm.

Machine virtuelle avec Vagrant

Vagrant allows you start a MediaWiki instance you can develop as well as allowing you to add and develop any of 250+ extensions - all with a single command. This saves you installation and configuration time compared to manually installing. It runs faster than Docker on Windows, however slower than Docker on WSL or manually installing.

Installation manuelle

MediaWiki can be developed by installing it natively on your system and editing its code. Installing it natively means it will run faster than Docker or Vagrant, but it will take more time to configure.

  1. Manuel:Instructions d'installation Check hardware requirements and install dependencies
  2. Télécharger à partir de Git — Téléchargez la dernière version du code source depuis Git.
  3. Guide d'installation — Poursuivez avec l'installation et la configuration initiale.
  4. * Configurez les différents modes de débogage dans votre environnement pour afficher les messages d'alerte et d'erreurs au plus tôt.

Conseils de communication et règles

Regardez comment un développeur corrige un bogue dans une extension MediaWiki, avec les investigations, les validations dans Git (commit), les relectures et fusion du code, ainsi que la fermeture du ticket Bugzilla (maintenant remplacé par Phabricator ).

Suivez ces conseils pour communiquer efficacement et obtenir de l'aide de la part des membres de la communauté.

Utiliser efficacement les tâches Phabricator

Si vous envisagez de travailler sur une tâche de Phabricator :

  • Il est inutile d'en demander la permission : Vous pouvez travailler sur les tâches non assignées sans demander que quelqu'un vous les assigne. Il n'existe aucune autorité qui assigne les tâches ou qui doit être consultée en priorité.
    • Si une tâche possède déjà une correction récente dans Gerrit, choisissez-en une autre à la place, sur laquelle vous allez travailler.
    • Si un patch dans Gerrit n'a pas été fusionné et n'a pas évolué depuis un long moment, vous pouvez l'améliorer en vous basant sur les commentaires qu'il aura reçus dans Gerrit et dans la tâche.
  • Faites d'abord votre recherche : Quand vous aurez décidé de travailler sur une tâche, faites certaines investigations avant de commencer à coder. Analysez le code, essayez de comprendre ce qu'il est supposé faire, lisez la documentation associée et essayez d'identifier les parties de code à modifier.
    • Dans une tâche Phabricator , utilisez les balises du projet dans la barre latérale pour trouver le dépôt de code correspondant à la tâche.
    • Si vous n'avez aucune idée sur la manière de corriger le bogue, essayez d'en trouver un autre, plus simple.
  • Il n'est pas utile de décrire vos plans avant de commencer à travailler sur une tâche, mais au moins signalez votre intention de travailler sur celle-ci.
    • Lorsque vous commencez à travailler, déclarez-vous responsable de la tâche en cliquant sur Edit Task… dans Phabricator, et en entrant votre nom d'utilisateur Phabricator dans la champ Assigned To. Ceci indique aux autres que vous travaillez dessus, afin qu'il n'y ait pas de doublon.
    • Si vous venez à modifier vos plans ou vos centres d'intérêt : Si vous arrêter de travailler sur une tâche, désassignez-vous de cette tâche. Ceci permet aux autres de savoir qu'il peuvent reprendre cette tâche et que vous n'allez plus travailler dessus.
  • Suivez l'étiquette de Phabricator.
    • Dans les tâches Phabricator, ne débatez que des questions spécifiques concernant le sujet de la tâche actuelle. N'utilisez pas Phabricator pour poser des questions d'ordre général, comme sur la façon de configurer un environnement de développement, ou comment corriger des problèmes avec Gerrit.

Rédiger des questions valides

  • Ne demandez pas simplement dans le but de poser une question !.
  • Soyez concis et fournissez le contexte : Au lieu de dire simplement « Pouvez vous me donner d'autres informations ? », « Aidez-moi ! » ou « Pouvez-vous me dire comment commencer ? », ajoutez l'information suivante à votre question :
    • Qu'essayez-vous de faire ?
    • Qu'avez-vous déjà essayé ? Copiez et collez vos commandes avec leurs résultats (si ce n'est pas trop long) au lieu de paraphraser avec vos propres mots.
    • Qu'avez-vous déjà découvert durant vos investigations ? Incluez les liens vers le code, la documentation ou les autres ressources que vous avez déjà consultées.
  • Utilisez les titres spécifiques et les lignes de sujet dans vos communications. Essai de proposition ou Aide demandée n'est pas spécifique.
  • Garder la conversation lisible : Lorsque vous répondez dans Zulip, dans les tâches Phabricator, ou sur les listes de diffusion, ne faites référence qu'aux sections des commentaires précédents qui ont un rapport avec votre réponse. Si vous citez un commentaire antérieur complet, cela peut rendre difficile la lecture des fils de discussion.

Suivre les règles de communication et les meilleures pratiques

Avant d'envoyer ou de publier votre question :

Demander au bon endroit

  • Posez vos questions de manière publique : n'envoyez pas de messages privés si le sujet de votre conversation n'est pas personnel. Les messages privés n'aident pas les autres.
  • Demandez et discutez à l'endroit qui est conçu pour cela :
    • Dans les tâches Phabricator, ne discutez que des questions liées au sujet de la tâche.
    • Posez vos questions générales techniques, comme sur la manière de configurer un environnement de développement ou de corriger les problèmes avec Gerrit, aux endroits indiqués sur Communication .
    • Si vous participez à un programme de sensibilisation, alors Zulip est à utiliser pour discuter des questions concernant les programmes de sensibilisation eux-mêmes.

Soyez patient

Après avoir publié votre question :

  • Ne demandez pas la relecture du code dans un message séparé. Les personnes qui recevront les notifications de Gerrit et de Phabricator y répondront quand elles pourront.
  • Si vous cherchez des réponses ou des commentaires, particulièrement durant les week-ends ou les vacances, il est possible que vous ayez à attendre jusqu'à l'heure d'ouverture des bureaux. Sur les canaux tels que IRC: si personne ne répond, essayez à nouveau à un autre moment; n'abandonnez pas simplement!
  • Si vous n'obtenez pas de réponse même après avoir attendu patiemment, voyez si d'autres canaux de communication ne seraient pas préférables pour poser votre question.

Annexes

 
Les contributeurs MediaWiki au travail à Bangalore, en Inde.

PHP

MediaWiki est écrit en PHP, vous aurez donc besoin de vous familiariser avec le langage PHP pour apporter des modifications au noyau de MediaWiki.

Apprendre PHP
  • Tutoriel PHP — Disponible dans plusieurs langues différentes. Si vous n'avez aucune connaissance en PHP, mais que vous savez comment programmer dans d'autres langages de programmation orientés objet, il vous sera alors facile d'apprendre ce langage.
  • La programmation PHP sur Wikilivres.
  • PHP sur Wikiversité.
Ressources PHP
Choses à savoir
  • Le script maintenance/eval.php dans MediaWiki fournit un interpréteur PHP de base avec des objets MediaWiki et des classes chargées.
  • Aussi, le script maintenance/shell.php dans MediaWiki remplace maintenance/eval.php basé sur PsySH, voir Manual:Shell.php

Base de données

Beaucoup de fonctionnalités nécessitent de nombreuses manipulations de la base de données, de sorte que vous aurez souvent besoin de vous familiariser avec MySQL/MariaDB.

Apprendre MySQL/MariaDB
Ressources MySQL/MariaDB
Choses à savoir
  • Testez votre code avec MySQL/MariaDB.
    • MediaWiki utilise actuellement MySQL et MariaDB en tant que base de données principale d'arrière-plan. Cela supporte aussi d'autres SGBD, comme PostgreSQL et SQLite. Cependant, presque tous les développeurs utilisent MySQL/MariaDB et ne testent pas d'autres bases de données, ce qui par conséquent peut faire planter régulièrement. Il vous est donc conseillé d'utiliser MySQL/MariaDB lors du test de vos patchs, sauf si vous êtes spécifiquement en train d'essayer d'améliorer le support pour une autre base de données. Dans ce dernier cas, assurez-vous que vous faites attention à ne pas casser MySQL/MariaDB (ou écrire des requêtes qui sont horriblement inefficaces dans celle-ci), puisque MySQL/MariaDB est ce que tout le monde utilise.

JavaScript et CSS

JavaScript et CSS sont devenus omniprésents pour la partie graphique « front-end » du code. Vous n'avez pas besoin de connaître le langage JavaScript, jQuery ni CSS pour travailler sur MediaWiki, mais vous en aurez peut-être besoin, en fonction de ce que vous choisissez de faire.

Apprendre JavaScript et CSS
Ressources JavaScript et CSS

MediaWiki

Le code de base de MediaWiki est grand et certaines parties sont assez laides ; ne soyez pas submergé. Lorsque vous démarrez pour la première fois, essayez d'écrire des fonctionnalités ou de corriger des bogues qui ne concernent qu'une petite portion du code.

Bases de MediaWiki et lectures recommandées
Ressources sur MediaWiki
  • Code — Une liste de fichiers importants et des liens vers des informations plus détaillées.
  • Accroches — Une liste d'attaches (hooks). Si vous essayez de trouver quelle partie du code de base fait telle chose, souvent un bon endroit pour commencer est de rechercher les attaches connexes.
  • Conventions de codage — Une vue d'ensemble des conventions de codage générales au sein de la communauté MediaWiki.
  • Documentation du code (référence de classe) — La documentation générée automatiquement à partir du code et des commentaires.
  • Comment déboguer — Un guide pour déboguer MediaWiki.
  • Manuel:Eval.php — Un outil pour interagir avec la vie des objets MediaWiki.

Extensions de MediaWiki

Si vous choisissez de travailler sur le code d'extensions MediaWiki, les liens suivants vous fourniront plus d'informations.

Notions de base concernant les extensions MediaWiki
Ressources pour les extensions MediaWiki

MediaWiki skins

Manual:How to make a MediaWiki skin is helpful if you choose to work on MediaWiki skins.

Voir aussi

  1. MediaWiki fonctionne sur la plupart des plateformes qui supportent PHP, cependant, l'absence de certains utilitaires ou de caractéristiques du système d'exploitation peuvent limiter les fonctionnalités ou les performances de MediaWiki sur les plateformes non LAMP.
  2. MediaWiki supporte d'autres bases de données DBMS que MySQL et MariaDB, dont Oracle, PostgreSQL, SQLite, et Microsoft SQL Server.
  3. L'équipe de développement est un ensemble de personnes volontaires et salariées (ou de consultants) pour différentes sociétés. Pour une liste complète de qui travaille sur le code de MediaWiki, lisez l'article Développeurs .
  4. Affichez le code source et les dépôts hébergeant les versions du code sur https://phabricator.wikimedia.org/diffusion/ ou téléchargez le code source sur votre système en utilisant Gerrit.