MediaWiki

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 94% complete.
Outdated translations are marked like this.
Other languages:

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[1]. Il utilise jQuery comme bibliothèque JavaScript cliente.

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

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

  • Le code source est géré sous le système de contrôle de version Git .[5]
  • 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 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). This is the recommended method.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers.

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

Vagrant is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.

Installation manuelle

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

Follow these tips to communicate effectively and get help from community members.

Use Phabricator tasks effectively

When you plan to work on a Phabricator task:

  • No need to ask for permission: You can work on unassigned tasks without asking someone to assign them to you. There is no authority who assigns tasks or who needs to be asked first.
    • If a task already has a recent patch in Gerrit, choose a different task to work on instead.
    • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could improve that existing patch, based on the feedback in Gerrit and in the task.
  • Faites d'abord votre recherche : When you consider working on a task, do research before you start coding. Look at the code, try to understand what it is supposed to do, read related documentation, and try to find the places where you need to make code changes.
    • In a Phabricator task, use the project tags in the side bar to find the code repository for the task.
    • Si vous n'avez aucune idée sur la manière de corriger le bogue, essayez d'en trouver un plus simple.
  • You do not need to announce your plans before you start working on a task, but you should communicate that you are working on the task.
    • When you start work, set yourself as task assignee by clicking Edit Task… in Phabricator, and set your Phabricator username in the Assigned To field. This communicates to others that you are working on it, so they don't duplicate work.
    • When your plans or interests change: If you are no longer working on a task, remove yourself as the assignee of the task. This tells others that they can work on the task, and they won't expect you to still work on it.
  • Follow Phabricator etiquette.
    • In Phabricator tasks, discuss only specific questions about the topic of that task. Don't use Phabricator to ask general questions, like how to set up a development environment or how to fix problems with Gerrit.

Compose good questions

  • Be specific and provide context: Instead of simply asking "Can you give me more info?", "Please guide me", or "Please tell me how to start", include the following information in your question:
    • What are you trying to achieve?
    • What have you already tried? Copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words.
    • What have you found out already during your research? Include links to code, documentation, or other resources you already consulted.
  • Use specific titles and subject lines in your communication. "Proposal draft" or "Need help" is not specific.
  • Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, only quote sections of previous comments that are relevant to your response. If you quote a complete previous comment, it makes threads hard to read.

Follow communication policies and best practices

Before you send or post your question:

Ask in the right place

  • 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.
  • Ask and discuss in the best place:
    • In Phabricator tasks, discuss only specific questions about the topic of that task.
    • Ask general technical questions, like how to set up a development environment or how to fix problems with Gerrit, in the places listed on Communication .
    • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.

Be patient

After you post your question:

  • Do not ask people for code review in a separate message. People receive Gerrit and Phabricator notifications and will respond when they can.
  • When seeking input and comments, especially during weekends and holidays, you may need to wait until business hours resume. On chat channels like IRC: if nobody answers, try again at a different time; don't just give up!
  • If you don't get an answer even after waiting and being patient, consider if other Communication channels might be a better place to ask your 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.
  • PHP Programming at Wikibooks.
  • PHP at Wikiversity.
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

Voir aussi

  1. ↑ La totalité de MediaWiki n'est pas écrite en PHP. Certains outils que nous supportons sont écrits dans d'autres langages, comme les fichiers batch, les scripts shell, les makefiles et Python.
  2. ↑ 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.
  3. ↑ MediaWiki supporte d'autres bases de données DBMS que MySQL et MariaDB, dont Oracle, PostgreSQL, SQLite, et Microsoft SQL Server.
  4. ↑ 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 .
  5. ↑ 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.
Retrieved from "https://www.mediawiki.org/w/index.php?title=How_to_become_a_MediaWiki_hacker/fr&oldid=5225853"