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. À noter que dans la plupart des cas, lorsque vous travaillez avec MediaWiki, vous ne voulez pas modifier le noyau de MediaWiki à moins que vous ne sachiez vraiment ce que vous voulez faire.

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.

MediaWiki est écrit en langage de programmation PHP. Il utilise jQuery comme bibliothèque JavaScript cliente.

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 les diverses listes de diffusion et canaux IRC. La liste de diffusion principale des développeurs est wikitech-l. Les principaux canaux IRC des développeurs sont #mediawiki et #wikimedia-dev.
• Le code source est géré sous le système de contrôle de version Git .
• La revue du code se fait sur Gerrit . Suivez ce tutoriel pour configurer Git et Gerrit pour soumettre des patchs.
• Les rapports de bogues et les tâches sont gérées dans Phabricator.

Cette page devrait vous aider à devenir un contributeur de MediaWiki. Ce n'est pas un tutoriel ; cela vous dirige simplement vers différents endroits où vous pouvez acquérir les connaissances dont vous avez besoin.

Configurer son environnement de développement

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 l'installation à partir d'une machine virtuelle pré-configurée (Vagrant ou Docker), ou en faisant une installation manuelle.

Machine virtuelle avec 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).

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).

Installation manuelle

• Configuration requise pour l'installation — Vérifiez la configuration matérielle requise, et installez un serveur LAMP, MAMP ou WAMP (Linux, Mac ou Windows, plus Apache, MySQL/MariaDB et PHP).

• Télécharger à partir de Git — Téléchargez la dernière version du code source depuis Git.
• Guide d'installation — Poursuivez avec l'installation et la configuration initiale.
• Configurez les différents modes de débogage dans votre environnement pour afficher les messages d'alerte et d'erreurs au plus tôt.

Il n'est pas nécessaire de télécharger des dumps de la base de données de Wikipédia pour pouvoir développer des fonctionnalités de MediaWiki. En fait, dans la plupart des cas il est plus facile d'utiliser une base de données presque vide avec quelques pages de test construites à cet effet. Cependant, si pour une raison particulière vous souhaitez avoir une copie de Wikipédia, vous pouvez obtenir un dump.

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 ).

• Faites d'abord votre recherche : lorsque vous décidez de travailler sur une tâche, vous êtes censés faire d'abord un travail d'investigation de base vous-même : lire le code, esayer de comprendre un peu ce qu'il est supposé faire, lire la documentation associée, essayer de trouver le ou les endroits probables ou vous allez faire vos corrections. Pour un aperçu général, veuillez lire les Bases à connaître.
  • In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
• Ask and discuss in the best place:
  • In Phabricator tasks, discuss only specific questions about the topic of that very Phabricator task. General technical questions (e.g. how to set up a development environment or problems with Gerrit) are off-topic in Phabricator tasks.
  • For general technical questions, ask the broader Wikimedia community and use generic channels like IRC chat or mailing lists. (If you take part in an outreach program, then you can also use Zulip's technical-support stream.)
  • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
• Ask good questions: "Can you give me more info?", "Please guide me", "Please tell me how to start" are not good comments to start with: The more specific your questions are, the more likely somebody can answer them quickly. If you have no idea at all how to fix the bug, maybe that bug is not (yet) for you – consider finding an easier one first.
• Provide context: When asking, explain what you want to achieve, and what you have tried and found out already, so others can help at the right level. Be specific – for example, copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words. This avoids misunderstandings.
• Ask in public: Do not send private messages if your conversation topic is not secret. Private messages do not help others.
• Be patient when seeking input and comments, especially during weekends and holidays.
  • On IRC, don't ask to ask, just ask: most questions can be answered by other community members too if you ask on an IRC channel. If nobody answers, please try again at a different time; don't just give up.
  • Do not ask people immediately for code review in a separate message. People receive Gerrit and Phabricator notifications.
• Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, please avoid unneeded quoting of a complete previous comment. Provide sufficient context and keep threads readable.
• Follow the code of conduct for Wikimedia technical spaces.

• When you plan to work on a Phabricator task:
  • No need to ask for permission: Usually there is no reason to ask if you can work on something or if somebody could assign a task to you. There is no authority who assigns tasks or who needs to be asked first.
  • You do not need to announce your plans before you start working on a task but it would be welcome. At the latest when you are close to proposing a patch for a task, it is good to announce that you are working on it, so that others don't duplicate work: If nobody else is already assigned, set yourself as task assignee by using the Add Action… → Assign/Claim dropdown.
  • Tasks with existing patches:
    • If a task already has a recent patch in Gerrit, choose a different task to work on instead – avoid duplicating work.
    • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also improve that existing patch, based on the feedback in Gerrit and in the task.
  • When your plans or interests change: If you don't work on a task anymore, please remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.

By communicating clearly and early you get attention, feedback and help from community members.

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.
• PHP Programming at Wikibooks.
• PHP topic at Wikiversity.

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

• Tutoriel MySQL — À partir du manuel de référence MySQL 5.0.
• MySQL at Wikibooks.

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 and CSS at Wikibooks.
• Mise en route avec jQuery — Un tutorial jQuery.
• Learning JavaScript — references and 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.
• Manuel: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.
• Manuel: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 qui montre comment créer une extension MediaWiki (slides).
• 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

Voir aussi

• Chercher du code dans les dépôts.
• Pôle des développeurs – Lorsque vous aurez bien lu toutes les informations contenues dans cet article, il sera temps de passer aux ressources d'informations présentes dans le pôle du développeur.
• Guide du développeur MediaWiki – un ensemble d'articles relatifs
• Code de conduite