How to become a MediaWiki hacker/de-formal

Dieser Artikel wurde geschrieben, um Entwicklern zu helfen, die notwendigen Fähigkeiten für die Entwicklung des MediaWiki-Kerns und MediaWiki-Erweiterungen zu erwerben.

Der Hauptweg, um mit der Wikimedia-Entwicklung zu beginnen, ist an Wikimedia-Projekten, die Mentoring anbieten, mitzuarbeiten. Eine Alternative ohne Mentoring ist es, einen guten ersten Fehler zu beheben.

Wenn Sie ein erfahrener Entwickler mit MediaWiki-Erfahrung sind, besuchen Sie stattdessen .

Für andere Möglichkeiten, um sich in der Wikimedia-Gemeinschaft zu engagieren, siehe .

Überblick
MediaWiki ist die Software, die Wikipedia, ihre Schwesterprojekte und Tausende von Wikis in der ganzen Welt betreibt.

Obwohl MediaWiki in PHP programmiert ist, sind einige Hilfs-Tools in anderen Sprachen geschrieben, so z. B. Stapelverarbeitungsdateien, Shellskripte, Makefiles und Python. .

Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python.

MediaWiki is primarily written for the LAMP platform and runs on most operating systems. MediaWiki benutzt hauptsächlich MySQL- oder MariaDB-Datenbanken.

Die Entwicklung geschieht im Stile von open source. Dies wird größtenteils online koordiniert und von der Wikimedia-Foundation unterstützt, freiwillige Entwickler tragen jedoch ebenfalls einen großen Teil bei.

Die allgemeine Mailingliste der Entwickler ist wikitech-l. The main developer IRC channels are and.
 * Development discussion happens on, , and IRC channels.
 * Source code is stored on and managed using the Git revision control system and can be viewed here
 * Code-Durchsichten werden auf durchgeführt und können hier angesehen werden. Follow this tutorial to set up Git and Gerrit in order to submit patches.
 * Bug reports and feature requests are filed, and projects are coordinated on and can be viewed here

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.

Set up your development environment
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 – Führen Sie MediaWiki aus mit Docker (kann auf Linux, Windows oder macOS als Hauptrechner genutzt werden).

Docker is a good option if you want to setup a MediaWiki installation quickly and are not planning on installing many extensions.

You can also try the new mwcli tool which sets up Docker with a few simple commands and provides basic orchestration functionality between MediaWiki, MySQL, ElasticSearch, Memcached, and other types of containers.

Virtuelle Maschine mit 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.

Local installation
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)  — Laden Sie sich den aktuellsten Quellcode von Git herunter.
 * 3)  — Setzen Sie dann die Installation und die Erstkonfiguration fort.
 * 4) * Aktivieren Sie frühzeitig die verschiedenen Debug Varianten in Ihrer Umgebung, um auf Warnungen und Fehler früher aufmerksam gemacht zu werden.

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 ist in PHP geschrieben, deshalb müssen Sie sich mit PHP vertraut machen, um am Kerncode von MediaWiki zu hacken.


 * PHP lernen
 * PHP-Anleitung — Erhältlich in vielen verschiedenen Sprachen. Wenn Sie kein Wissen über PHP haben, aber in anderen objektorientierten Programmiersprachen programieren können, wird PHP für Sie einfach zu erlernen sein.
 * PHP Programming at Wikibooks.
 * PHP at Wikiversity.


 * Quellen zu PHP:
 * Das PHP-Handbuch — Erhältlich in vielen verschiedenen Sprachen.
 * PHP-Programmier-Konventionen in der MediaWiki-Gemeinschaft.


 * Wissenswertes:
 * Das Skript  in MediaWiki stellt einen grundlegenden PHP-Interpreter bereit, in dem MediaWiki-Objekte und Klassen bereits geladen sind.
 * Also, the script  in MediaWiki is a replacement of   based on PsySH, see

Datenbank
Viele Funktionen benötigen einiges an Datenbank-Änderungen. Daher wird es häufig notwendig sein, dass Sie mit MySQL/MariaDB vertraut sind.


 * Lernen Sie MySQL/MariaDB
 * MySQL-Anleitung — Aus dem MySQL-Referenzhandbuch.
 * MySQL at Wikibooks.


 * MySQL/MariaDB-Ressourcen
 * MySQL-Referenzhandbücher — Erhältlich in vielen verschiedenen Sprachen.
 * MariaDB-Wissensbasis
 * Datenbank-Programmier-Konventionen in der MediaWiki-Gemeinschaft.


 * Wissenswertes:
 * Testen Sie Ihren Code mit MySQL/MariaDB.
 * MediaWiki verwendet aktuell MySQL und MariaDB als hauptsächliches Datenbank-Backend. Es unterstützt auch andere Datenbanksysteme, wie beispielsweise PostgreSQL und SQLite. Allerdings nutzen fast alle Entwickler MySQL/MariaDB und testen nicht mit anderen Datenbanken. Dadurch kommte es regelmäßig dazu, dass diese nicht mehr richtig funktionieren. Es ist daher empfehlenswert, MySQL/MariaDB zu nutzen, wenn man Korrekturen (Patches) testet, es sei denn, Sie versuchen eben, die Unterstützung einer anderen Datenbank zu verbessern. Stellen Sie in diesem Fall sicher, dass Sie MySQL/MariaDB nicht kaputt machen (oder Abfragen schreiben, die schrecklich ineffizient sind), denn MySQL/MariaDB wird von allen anderen genutzt.

JavaScript and CSS
JavaScript und CSS sind im Frontend-Code allgegenwärtig geworden. Sie müssen nicht mit JavaScript, jQuery und CSS vertraut sein, um an MediaWiki zu arbeiten, aber es ist möglicherweise notwendig, je nachdem, an was Sie arbeiten wollen.


 * JavaScript and CSS lernen
 * JavaScript and CSS at Wikibooks.
 * Erste Schritte mit jQuery — Eine jQuery-Anleitung.
 * Learning JavaScript — references and sources.


 * Quellen zu JavaScript und CSS
 * JavaScript-Programmier-Konventionen in der MediaWiki-Gemeinschaft.
 * CSS-Programmier-Konventionen in der MediaWiki-Gemeinschaft.

MediaWiki
Die MediaWiki-Codebasis ist groß und einige Bereiche sind hässlich; seien Sie nicht von ihr überwältigt. Zum ersten Einstieg versuchen Sie, Funktionen zu schreiben oder Fehler zu beheben, die nur einen kleinen Bereich des Codes betreffen.


 * MediaWiki-Überblicksartikel und Pflichtlektüre:
 *  — Eine Überblick aus der Vogelperspektive über die Hauptkomponenten von MediaWiki und wie diese zusammenarbeiten.
 *  — Ein Überblick darüber, warum und wie man sicheren Code schreibt.


 * Quellen zu MediaWiki:
 * — Eine Liste der wichtigen Dateien und Links zu weiteren Informationen.
 * — Eine Liste von Hooks. Wenn Sie versuchen, herauszufinden, welcher Teil des Codes etwas bestimmtes tut, ist es häufig ein guter Ausgangspunkt, nach den entsprechenden Hooks zu suchen.
 * — Ein Überblick über die allgemeinen Konventionen zum Programmierstil innerhalb der MediaWiki-Gemeinschaft.


 * Code-Dokumentation (Klassenreferenz) — Automatisch aus dem Code und den Codekommentaren erstellte Dokumentation.
 * — Eine Anleitung für das Debuggen von MediaWiki.
 * — Ein Werkzeug, um live mit MediaWiki-Objekten zu interagieren.



MediaWiki-Erweiterungen
Wenn Sie am Code von MediaWiki Erweiterungen arbeiten wollen, bieten die folgenden Links weitergehende Information.


 * Überblicksartikel für MediaWiki-Erweiterungen:
 * Erweiterungen entwickeln — Wie man eine Erweiterung für MediaWiki schreibt.
 * Anleitung zum Schreiben von Erweiterungen


 * Quellen zu MediaWiki Erweiterungen:
 * Beste Praktiken für Erweiterungen
 * Eine kurze Einführung in die Erweiterungsentwicklung für MediaWiki — Eine Videopräsentation darüber, wie man eine MediaWiki Erweiterung erstellt (Folien).
 * Eine MediaWiki Erweiterung bauen — Behandelt, wie man eine Erweiterung für MediaWiki entwickelt, bewährte Vorgehensweisen und wie man sich mit der MediaWiki Community bekannt macht. Von Februar 2011.
 * Help for extension developers on the Developer Hub

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



Siehe auch

 * Search for code across repositories
 * – Wenn Sie die Informationen in diesem Artikel gründlich gelesen haben, ist es an der Zeit, weiter zu den Informationen im Entwickler-Zentrum zu gehen.