How to become a MediaWiki hacker/fr

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 .

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

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, , et sur les canaux IRC. La liste de diffusion principale des développeurs est wikitech-l. Les principaux canaux IRC des développeurs sont et.
 * Le code source est enregistré sous, géré en utilisant le système de contrôle de version Git et consultable ici.
 * La revue du code se fait sur 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 et peuvent être vus ici

Find or create a task
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

 * MediaWiki Vagrant – Run MediaWiki on a Linux virtual machine using 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 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)  — Check hardware requirements and install dependencies
 * 2)  — Téléchargez la dernière version du code source depuis Git.
 * 3)  — 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.

Open a code editor
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.

Change and test the code
Change the code and view your changes by reloading your MediaWiki browser tab. Make sure to follow. 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.

Create a patch
Finally, to submit your code to be reviewed and added to the repository you are contributing to, follow.



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  dans MediaWiki fournit un interpréteur PHP de base avec des objets MediaWiki et des classes chargées.
 * Aussi, le script  dans MediaWiki remplace   basé sur PsySH, voir

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.


 * 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:
 *  — Une vue d'ensemble de haut niveau des principaux composants de MediaWiki et comment ils fonctionnent les uns avec les autres.
 *  — Un aperçu de « pourquoi et comment écrire du code sécurisé ».


 * Ressources sur MediaWiki:
 * — Une liste de fichiers importants et des liens vers des informations plus détaillées.
 * — 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.
 * — 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.
 * — Un guide pour déboguer MediaWiki.
 * — 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

MediaWiki skins
is helpful if you choose to work on MediaWiki skins.



Voir aussi

 * Chercher du code dans les dépôts.
 * – 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.