Jump to content

Comment devenir un hackeur de MediaWiki

From mediawiki.org
This page is a translated version of the page How to become a MediaWiki hacker and the translation is 99% complete.
Languages:

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

Il est souvent difficile de contribuer à MediaWiki donc si vous souhaitez plutôt participer au développement de Wikimedia vous devriez 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.

La majeure partie de MediaWiki et des extensions est écrite en langage de programmation PHP. JavaScript est utilisé pour fournir les éléments d'interface interactifs avec jQuery et Vue.js comme librairies client JavaScript.

D'autres outils pris en charge son écrits dans d'autres langages, comprenant les fichiers de traitement par lots (batch), les scripts shell, les fichiers Makefile et Python.

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 bénévoles joue également un rôle important.

Chercher ou créer une tâche

Avant de développer une fonctionnalité ou de corriger un bogue dans un projet MediaWiki, il est important que vous investiguiez à ce sujet. Cela comprend :

  1. Regardez dans Phabricator s'il existe déjà une tâche ouverte ou fermée (champ « Document Types »). Si ce n'est pas le cas, créez-la. Ceci est une très petite modification, ne la créez pas.
  2. Cherchez et investiguez le code qui doit être modifié pour implémenter la fonctionnalité. Commentez ce que vous avez trouvé dans la tâche Phabricator si cela peut être utile aux autres contributeurs qui vont l'implémenter, ou vont relire vos modifications.
  3. Déterminez si vous pouvez probablement ajouter la fonctionnalité ou corriger le bogue en fonction du code que vous avez étudié et des modifications nécessaires. Si la tâche est importante ou complexe, cherchez quelque chose de plus simple et travaillez par la suite avec des tâches de cette taille. Si vous pensez que vous pouvez la réaliser, assignez-vous vous-même à la tâche et commencez à travailler.

Configurer son environnement de développement

Une fois que vous avez trouvé un sujet sur lequel travailler, la prochaine étape pour développer MediaWiki ou une extension est de créer un environnement pour exécuter MediaWiki, sa base de données et toute autre fonctionnalité externe afin que vous puissiez les développer et les tester.

Vous pouvez installer et développer MediaWiki sous Linux, Windows, ou macOS en utilisant une des trois solutions ci-dessous.

Docker

Docker est une bonne solution si vous voulez installer rapidement un MediaWiki et sans vouloir installer les nombreuses 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 sur une machine virtuelle Linux (utilisable sous Linux, Windows, ou Mac).

Vagrant vous permet de démarrer une instance de MediaWiki que vous pouvez développer, tout en vous permettant d'ajouter et de développer n'importe laquelle des 250+ extensions - le tout en une seule commande.

Cela vous permet d'économiser du temps d'installation et de configuration par rapport à l'ajout manuel des extensions dans une intallation Docker ou locale, mais il fonctionne un peu plus lentement que les deux autres options.

Installation locale

L'installation locale est une bonne option si vous souhaitez mettre en place rapidement un environnement de développement simple sans utiliser Docker.

Ouvrir un éditeur de code

Les deux éditeurs de code recommansés pour modifier MediaWiki sont VSCode et PhpStorm. VSCode est gratuit et PhpStorm est payant, néanmoins vous pouvez obtenir une licence PhpStorm gratuite (si vous êtes étudiant) en reliant votre compte GitHub Education à votre compte JetBrains, ou en demandant une licence pour le compte de Wikimedia.

Pour déterminer quel éditeur vous devez installer et utiliser, sachez que globalement, PhpStorm a davantage de fonctionnalités plus puissantes que VSCode. Cependant, le chargement de PhpStorm prend beaucoup plus de temps que celui de VSCode, car il crée un index de l'ensemble du référentiel, tandis que VSCode se charge progressivement. Par conséquent, VSCode est généralement utile pour visualiser des fichiers ou de petites modifications alors que PhpStorm sert pour des changements plus importants. Il est logique d'avoir installé les deux pour ces raisons.

Pour développer la base de code MediaWiki qui se trouve à l'intérieur d'un conteneur Docker, vous pouvez établir une connexion à distance et ouvrir le dossier MediaWiki à l'intérieur en utilisant VSCode ou PhpStorm.

Modifier et tester le code

Modifiez le code et affichez vos modifications en rechargant votre onglet MediaWiki du navigateur. Assurez-vous de suivre Conventions de codage . Ecrivez et exécutez les tests pour votre code pour vérifier qu'il fonctionne et qu'il est formaté correctement.

vous gagnez du temps en vous vérifiant que vos modifications seront acceptées avant de prendre le temps d'écrire des tests.

Créez une correction sans tester et demandez à quelqu'un de la revoir en disant que vous ajouterez les tests après qu'elle ait été revue.

Créer un patch

Enfin, pour soumettre votre code à la relecture et à son ajout au référentiel auquel vous contribuez, suivez 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 :

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

Introduction to MediaWiki core concepts

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

Introduction to MediaWiki extensions

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

Habillages MediaWiki

Manuel:Comment créer un habillage MediaWiki est utile si vous souhaitez travailler sur les habillages MediaWiki.

Voir aussi

Notes

  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 autres que MySQL et MariaDB, dont PostgreSQL et SQLite.
  3. ↑ L'équipe de développement est un ensemble de personnes bénévoles 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 versions des dépôts de code sur https://phabricator.wikimedia.org/diffusion/ ou téléchargez le code source sur votre système en utilisant Gerrit.
Retrieved from "https://www.mediawiki.org/w/index.php?title=How_to_become_a_MediaWiki_hacker/fr&oldid=6930931"