MWArchitecture

https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker/fr

Afterword: Wiki databases

The concept of a wiki could be described in one sentence: a website where every page has an "edit" button, which you can click on to edit the contents of that page. Over 20 years later, if you were to set up a new wiki it could again be described with that sentence.

If you have a MediaWiki instance with some combination of Cargo, Semantic MediaWiki, Page Forms and some of the other extensions discussed in this book installed on it, though, then you have something new. The operative fact about the website is that pages are not only editable, but structured; and there are built-in views of the data like tables, calendars and maps. The wiki is not just a text editor, but a data editor. This is now quite a different proposition.

The term I would suggest in its place is "wiki database". It clarifies that this website combines the editability of wikis, with the power of a database-backed website. Just as with a standard database-backed website, you can use forms to edit data. But on a standard website, any specific set of data can only be edited by one or few people. On a "wiki database", you can let any number of people edit your data, even anyone in the world; thanks to a comprehensive and accessible version history, there's no danger that a bad edit will cause lasting damage. Users have the freedom to essentially modify all the content however they wish, but their changes can be reverted, and there's also a structure in place to avoid chaos or confusion.

To create a standard database-backed website is often a serious undertaking, requiring any or all of a programming team, a DBA, a UI designer, a QA team, a project manager, a spec, a kickoff meeting, weekly milestones, and so on and son on. With a wiki database, you can just create the data structure directly on the wiki, and you're done; a task that might have taken weeks or months can now be done in hours or days. (Though having a designer involved might still be useful.)

Wikis are a little over 20 years old, and, like many 20-year-olds, they are still evolving. Happy adventures.

Cet article est destiné à aider les développeurs à développer les aptitudes nécessaires à la contribution du développement de MediaWiki.

• Dans la plupart des cas, lorsque vous travaillez avec MediaWiki, vous ne voulez pas modifier le noyau MediaWiki sans savoir vraiment ce que vous êtes en train de faire.
• Les deux méthodes principales pour commencer avec le développement MediaWiki sont de résoudre un petit bug ennuyeux dans le code existant, ou bien d'ajouter une nouvelle fonctionnalité, généralement par le biais d'une extension MediaWiki.

Aperçu

MediaWiki est le logiciel qui propulse Wikipédia, ses projets frères et des milliers d'autres wikis dans le monde.

MediaWiki is written in the PHP programming language[1]. It uses jQuery as the client JavaScript library.

MediaWiki is primarily written for the LAMP platform[2] and runs on most operating systems. MediaWiki primarily uses the MySQL and MariaDB database servers.[3]

Development happens in an open source style[4], is largely coordinated online, and supported by the Wikimedia Foundation, though volunteer community developers play a huge part as well.

• Development discussion happens on various mailing lists and IRC channels. The main developer list is wikitech-l. The main developer IRC channels are #mediawiki and #wikimedia-dev.
• Source code is managed using the Git revision control system.[5]
• Code review is performed on Gerrit. Follow this tutorial to set up Git and Gerrit in order to submit patches.
• Bug reports and tasks are managed on Phabricator.

Cette page devrait vous aider à démarrer sur le chemin qui mène à devenir un contributeur de MediaWiki.

Ce n'est pas un tutoriel; celà vous dirige tout simplement vers différents endroits où vous pouvez acquérir toutes les connaissances dont vous avez besoin.

Premiers pas

Commencez par vous enregistrer dans $dev et lisez le Tutoriel Gerrit.

Vous pouvez ensuite allez 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: utiliser une machine virtuelle pré-configurée (Vagrant), ou faire l'installation manuellement.

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)

Installation manuelle

• Configuration requise pour l'installation ­ Vérifiez la configuration matérielle requise, et installez un serveur LAMP, MAMP ou WAMP (Linux, Mac or Windows, plus Apache, MySQL/MariaDB and PHP).
• Télécharger à partir de Git ­ Téléchargez la dernière version du code source depuis Git.
• Manuel:Guide d'installation ­ Poursuivez avec l'installation et la configuration initiale.
• Configurez les différents modes de débogage dans votre environnement pour afficher précocement les messages d'alerte et d'erreurs.

Il n'est pas nécessaire de télécharger les dumps de la base de données Wikipedia pour pouvoir développer des fonctionnalités 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 Wikipedia, vous pouvez récupérer un dump.

Lectures suggérées

Regardez comment un développeur corrige un bogue, y compris les investigations, les Git commits, les relectures et fusion du code, ainsi que la fermeture du ticket Bugzilla (maintenant remplacé par Phabricator).

Retours, questions et support

• Vous êtes censé faire de la recherche basique par vous-même dans un premier temps: Regardez le code, essayez de comprendre ce qu'il est censé faire, lisez la documentation correspondante, essayez de trouver le(s) emplacement(s) probable(s) où vous devez faire des changements dans le but de corriger le bogue.
• Si vous avez des questions générales sur l'infrastructure, l' architecture logicielle ou les workflows qui ne sont pas liés spécifiquement au bogue sur lequel vous voulez travailler, utilisez des canaux génériques comme IRC, les listes de diffusion ou les pages de discussion wiki.

Par exemple, si vous avez un problème avec Gerrit, la page de discussion de Gerrit pourrait être un bon endroit pour poser une question ou demander de l'aide.

• Si vous avez une question précise sur le bogue lui-même, ajoutez des commentaires dans le rapport Phabricator correspondant.

"Que dois-je faire pour corriger ce bogue?" n'est pas une [good question to start with|bonne question pour commencer]: Plus vos questions sont précises, plus il probable que quelqu'un puisse y répondre rapidement. Si vous n'avez aucune idée de comment réparer le bogue, peut-être que ce bogue n'est pas (encore) pour vous - merci d'envisager d'en trouver un autre plus facile dans un premier temps.

• Lorsque vous effectuez une demande, expliquez ce que vous avez essayé de faire et déjà découvert, alors d'autres personnes pourront vous aider en se mettant à votre niveau.

Essayez d'être précis - par exemple, faire un copier/coller de vos commandes et du résultat affiché en sortie (si ce n'est pas trop long) au lieu de paraphraser dans vos propres mots. Cela permet d'éviter les malentendus.

• Évitez les emails privés ou les requêtes de support dans nos canaux de médias sociaux.
• Merci d'être patient lorsque vous recherchez l'entrée et les commentaires.

Sur un canal 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 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 laissez pas la question sans réponse.

• En savoir davantage sur comment communiquer.

Faire savoir que vous travaillez sur un bogue

Vous n'êtes pas obligé d'être mentionné comme l'initiateur dans un rapport de bogue ou d'annoncer vos objectifs avant le démarrage d'une résolution de bogue, mais ça serait bienvenu.

You are welcome to set yourself as the assignee in a task: Use the dropdown Add Action… Assign/Claim in Phabricator.

A la fin lorsque vous êtes proche de la création d'un patch pour le bogue, il est bon de mentionner dans un commentaire que vous êtes en train de travailler dessus.

Votre annonce évite ainsi à d'autres de ne pas travailler sur le bogue en même temps et de faire double travail.

Veuillez noter également que si un rapport de bogue possède déjà un lien récent vers un patch dans Gerrit et a également comme projet associé le projet "Patch-For-Review", vous devez choisir un autre bogue pour éviter de travailler en doublon.

Si le patch dans Gerrit n'a pas été fusionné et n'a pas connu de changements depuis une longue période, vous pouvez aussi récupérer ce patch existant et essayer de l'améliorer.

Si vous arrêtez de travailler sur une tâche, vous devez vous retirer en tant que cessionnaire d'un rapport de bogue et réinitialiser le cessionnaire au cessionnaire par défaut, pour que les autres puissent savoir qu'ils peuvent choisir de travailler sur cette tâche sans croire que vous y travaillez toujours.

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

Annexes

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

Truc à savoir

• Le script maintenance/eval.php dans MediaWiki fournit un interpréteur PHP de base avec des objets MediaWiki et des classes chargées.

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 ­ A 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 de MariaDB
• Règles de codage des bases de données dans la communauté MediaWiki.
• Accessing the database

Truc à 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 BD, ce qui par conséquent "break on a regular basis". il vous êtes donc conseillé d'utiliser MySQL/MariaDB lors du test des patches, 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 language JavaScript, jQuery et 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.
• Convention de codage CSS dans la communauté MediaWiki.

MediaWiki

Le code de base de MediaWiki est grand et certaines parties sont "moches"; Ne soyez pas submergé.

Lorsque vous démarrez, essayez d'écrire des fonctionnalités ou de corriger des bugs qui se limitent à une petite portion de code. Ressources 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.
• Security for developers ­ Un aperçu de "pourquoi et comment écrire du code sécurisé".

Ressources sur MédiaWiki

• Manual:Code ­ Une liste de fichiers importants et des liens vers des informations plus détaillées.
• Manual:Hooks ­ Une liste de "crochets" (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 "crochets" (hooks) connexes.
• Manual:Coding conventions ­ Une vue d'ensemble des conventions de codage générales au sein de la communauté MediaWiki.
• Documentation du code ­ La documentation générée automatiquement à partir du code et des commentaires.
• Manuel:Comment déboguer ­ Un guide pour déboguer MediaWiki.
• Manual:Eval.php ­ Un outil pour interagir avec la vie des objets MediaWiki.

Travailler sur les extensions

Si vous choisissez de travailler sur le code d'extensions MediaWiki, les liens suivants vous fourniront plus d'informations. Ressources pour les extensions MediaWiki :

• Développer des extensions ­ Comment écrire une extension pour MediaWiki.
• Tutoriel - Écrire une Extension

Ressources pour les extensions MediaWiki

• Best practices for extensions
• A brief introduction to MediaWiki extension development ­ Une présentation vidéo qui montre comment créer une extension MediaWiki (slides).
• Making a MediaWiki extension ­ Montre comment développer une extension pour Mediawiki, les meilleures pratiques, et comment engager la communauté Mediawiki. Depuis février 2011.
• Help for extension developers on the Developer Hub

Voir aussi

• 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 sanctuaire du développeur.
• MediaWiki Developers Guide – a collection of related pages
• Code de conduite

Not all of MediaWiki is written in PHP. Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python. MediaWiki runs on most platforms that can support PHP, however, the lack of certain utilities or operating system features may limit the functionality or performance of MediaWiki on non-LAMP platforms. MediaWiki has support for DBMS other than MySQL and MariaDB, including Oracle, PostgreSQL, SQLite, and Microsoft SQL Server. Developers are a mix of volunteers and paid staff (or contractors) for various organizations. For a full list of who works on the MediaWiki code, read the Developers article. Browse the source code and revisions of code repositories at https://phabricator.wikimedia.org/diffusion/ or download the source code to your system by using Gerrit.