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

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.

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 . 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échargez la dernière version du code source depuis Git.
 * — 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.

Lectures suggérées


Retours, questions et support

 * Vous êtes censé faire les investigations de base par vous-même dans un premier temps : regardez le code, essayez de comprendre ce qu'il doit faire, lisez la documentation correspondante, essayez de trouver le(s) endroit(s) probable(s) où vous devez faire des changements dans le but de corriger le bogue.
 * In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
 * Si vous avez des questions générales qui ne sont pas liées à la tâche spécifique sur laquelle vous voulez travailler, utilisez les canaux génériques comme le salon de discussion IRC ou les listes de diffusion mais pas la tâche spécifique. Les questions sur la manière de configurer votre environnement de de développement, ou sur la manière d'utiliser Gerrit sont hors sujet pour une tâche.
 * Si vous avez une question précise sur le bogue lui-même, ajoutez vos commentaires dans le rapport de bogue associé (normalement c'est une tâche de ). « Pouvez-vous me donner plus d'informations sur la manière dont je dois corriger ce bogue ? » n'est pas une [good question to start with|bonne question pour commencer] : plus vos questions seront précises, et plus il probable que quelqu'un pourra y répondre rapidement. Si vous n'avez aucune idée sur la manière de corriger le bogue, peut-être que ce bogue n'est pas (encore) pour vous — merci d'essayer d'en trouver un autre plus facile dans un premier temps.
 * Lorsque vous demandez quelque chose, expliquez ce que vous avez essayé de faire et déjà découvert, pour que les réponses des autres personnes soient au niveau des questions posées. Soyez précis — par exemple, au lieu de paraphraser avec vos propres mots, faites un copier/coller de vos commandes et du résultat affiché en sortie (si ce n'est pas trop long). Cela permet d'éviter les malentendus.
 * Ne demandez pas si vous pouvez travailler sur une tâche. Do not ask to assign a task to you.
 * Évitez les emails privés ou les requêtes de support sur nos canaux de médias sociaux.
 * Soyez patient lorsque vous recherchez une entrée ou des commentaires. Sur IRC, ne demandez pas juste pour demander, demandez simplement : la plupart des questions peuvent être résolues par d'autres membres de la communauté si vous utilisez un canal IRC. Si personne ne répond, merci de faire une demande sur la page de rapport de bogue ou la page wiki en relation avec le problème ; ne baissez pas les bras.



Faire savoir que vous travaillez sur une tâche
Ne demandez pas si vous pouvez travailler sur une tâche. Vous n'êtes pas obligé non plus d'annoncer ce que vous comptez faire avant de travailler sur une correction, mais ça serait bienvenu. Do not ask to assign a task to you. You do not need to announce your plans before you start working on a bug, but it would be welcome. Vous êtes toujours invité à vous affecter la responsabilité d'une tâche : utilisez la liste déroulante Add Action… → Assign/Claim dans Phabricator. Enfin, lorsque vous êtes sur le point de proposer un patch pour la tâche, il est bon de mentionner dans un commentaire que vous êtes en train de travailler dessus. Votre annonce évite ainsi à d'autres personnes de travailler sur le bogue en même temps et de faire le travail en double.

Veuillez noter également que si une tâche possède déjà un lien récent vers un patch dans Gerrit et a également dans Phabricator le projet « Patch-For-Review » associé, vous devez choisir à la place une autre tâche sur laquelle vous allez travailler, afin d'éviter le doublon. Si un patch existant dans Gerrit n'a pas été fusionné et n'a pas connu de changements depuis une longue période, vous pouvez aussi le récupérer et essayer de l'améliorer en prenant en compte les remarques présentes dans Gerrit et sur la tâche.

Si vous arrêtez de travailler sur une tâche, retirez-vous du poste de responsable de la tâche, afin que les autres puissent voir qu'ils peuvent travailler sur cette tâche sans penser que vous êtes encore dessus.

En communiquant dès le début, vous obtiendrez plus d'attention, de retour et d'aide des membres de la communauté.



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


 * 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:
 *  — 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 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.
 * – 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.
 * – un ensemble d'articles relatifs