Comment devenir un hackeur de MediaWiki

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.

MédiaWiki est écrit en langage de programmation PHP. Devanagari est utilisé pour fournir des éléments d'interface interactif avec jQuery et Vue.js comme librairies client JavaScript.

Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python.

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

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

• Les discussions concernant le développement se font sur Phabricator , Listes de diffusion , et sur les canaux IRC. La liste de diffusion principale des développeurs est wikitech-l. Les principaux canaux IRC des développeurs sont #mediawiki ^connecter et #wikimedia-dev ^connecter.
• Le code source est enregistré sous Gerrit , géré en utilisant le système de contrôle de version Git et consultable ici.
• 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 et demandes de fonctionnalités sont soumis, et les projets sont gérés dans Phabricator et peuvent être vus ici

Chercher ou créer une tâche

Before you ever develop a feature or fix a bug in a MediaWiki project, it is important that you do your research about it. This includes:

1. Search Phabricator if an open or closed Task (Document Types field) already exists. If it doesn't, create one. If this is a very small change, don't create one.
2. Find and investigate the code that needs to be changed to implement the feature. Comment your findings on the Phabricator Task if they might be helpful to others who implement it or review your changes.
3. Determine if you can likely add the feature or fix the bug based the code you investigated and the changes needed. If the task is large or complex, you should find something easier and work your way up to eventually be able to handle tasks of that size. If you believe you can complete it, assign yourself to the Task and begin working on it.

Configurer son environnement de développement

Once you have found something you can work on, the next step to developing MediaWiki or an extension is creating an environment to run MediaWiki, its database, and any other external features so that you can develop and test them.

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

Docker

• MediaWiki Docker — exécuter MediaWiki en utilisant Docker.

Docker is a good option if you want to setup a MediaWiki installation quickly and are not planning on installing many extensions.

Vous pouvez également essayer l'outil mwcli qui configure Docker avec quelques commandes simples et fournit des fonctionnalités d'orchestration de base entre MediaWiki, MySQL, ElasticSearch, Memcached et d'autres types de conteneurs.

Vagrant

• Installation de Vagrant — Ces étapes installeront un serveur MediaWiki avec tous les prérequis dans une machine virtuelle Linux (utilisable sous Linux, Windows, ou Mac).

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 adding extensions in a Docker or local installation, but it runs a bit slower than the other two options.

Installation locale

MediaWiki can be developed by installing it and its dependencies locally on your system.

It will take much more time to set up than Docker or Vagrant.

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.

Ouvrir un éditeur de code

The two recommended code editors for editing MediaWiki are VSCode and PhpStorm. VSCode is free and PhpStorm is paid, however, you can acquire a PhpStorm license for free if you are a student by linking your GitHub Education account to your JetBrains account, or by requesting a license granted to Wikimedia.

To determine which editor you should install and use, know that all-around, PhpStorm has more and more-powerful features than VSCode. However, PhpStorm takes significantly longer to load on start than VSCode as it builds an index of the entire repository whereas VSCode progressively loads. Therefore, VSCode is typically useful for file-viewing sessions or small changes and PhpStorm for larger changes. It makes sense to have both installed for these reasons.

To develop the MediaWiki codebase that is inside a Docker container you can establish a remote connection to it and open the MediaWiki folder inside it using VSCode or PhpStorm.

Modifier et tester le code

Change the code and view your changes by reloading your MediaWiki browser tab. Make sure to follow Conventions de codage . Write and run tests on your code to make sure it works and is formatted properly.

Note, you can save time by ensuring your changes will be accepted before taking the time to write tests. Create a patch without needed tests and ask for someone to review it stating that you will add tests after they review it.

Créer un patch

Finally, to submit your code to be reviewed and added to the repository you are contributing to, follow Gerrit/Tutoriel .

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 :

• Lisez et suivez le code de conduite des espaces techniques Wikimedia.
• Utilisez le Langage inclusif  : Au lieu d'utiliser des termes longs qui supposent une identité de genre (tels que Les gars, Madame, ou Monsieur) remplacez-les par le nom de la personne.

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

• Le manuel de PHP — Disponible dans plusieurs langues différentes.
• Règles de codage PHP dans la communauté MediaWiki.

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 Manuel: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

• Tutoriel MySQL — À partir du manuel de référence MySQL.
• MySQL sur Wikilivres.

Ressources MySQL/MariaDB

• Manuels de référence MySQL — Disponible dans plusieurs langues différentes.
• Base de connaissances MariaDB
• Règles de codage des bases de données dans la communauté MediaWiki.
• Accéder à la base de données

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

• JavaScript et CSS sur Wikilivres.
• Mise en route avec jQuery — Un tutoriel jQuery.
• Apprendre JavaScript — références et sources.

Ressources JavaScript et CSS

• Conventions de codeage JavaScript dans la communauté MediaWiki.
• Conventions de codage CSS dans la communauté MediaWiki.

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

• Architecture MediaWiki — Une vue d'ensemble de haut niveau des principaux composants de MediaWiki et comment ils fonctionnent les uns avec les autres.
• Sécurité pour les développeurs — Un aperçu de « pourquoi et comment écrire du code sécurisé ».

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

• Développer des extensions — Comment écrire une extension pour MediaWiki.
• Tutoriel sur l’écriture d'une extension

Ressources pour les extensions MediaWiki

• Meilleures pratiques pour les extensions
• Une brève introduction au développement d'extensions de MediaWiki — Une présentation vidéo sur la façon de créer une extension MediaWiki (diapositives).
• Faire une extension de MediaWiki — Montre comment développer une extension pour Mediawiki, les meilleures pratiques, et comment engager la communauté MediaWiki. Depuis février 2011.
• Aide pour les développeurs d'extensions sur le portail des développeurs

Habillages MediaWiki

Manuel:Comment créer un habillage MediaWiki is helpful if you choose to work on MediaWiki skins.

Voir aussi

• Chercher du code dans les dépôts.
• Pôle des développeurs – Lorsque vous aurez lu attentivement toutes les informations contenues dans cet article, il sera temps de passer aux informations présentes dans le pôle des développeurs.
• Code de conduite