Wie man ein MediaWiki-Hacker wird

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 du ein erfahrener Entwickler mit MediaWiki-Erfahrung bist, besuche stattdessen Entwickler-Zentrum .

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

Ü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.</ref>. JavaScript is used for providing interactive interface elements along with jQuery and Vue.js as client JavaScript libraries.

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.

• Development discussion happens on Phabricator , Mailinglisten , and IRC channels.

Die allgemeine Mailingliste der Entwickler ist wikitech-l. The main developer IRC channels are #mediawiki ^connect and #wikimedia-dev ^connect.

• Source code is stored on Gerrit and managed using the Git revision control system and can be viewed here.

• Code-Durchsichten werden auf Gerrit durchgeführt und können hier angesehen werden. Follow this tutorial to set up Git and Gerrit in order to submit patches.

• Fehler-Meldungen und Aufgaben werden auf Phabricator verwaltet.

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ühre 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 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

• Installation von Vagrant - Diese Schritte werden den MediaWiki-Server mit allen Vorraussetzungen innerhalb einer Linux-VM installieren (kann unter Linux-, Windows- und Mac-Hosts verwendet werden)

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.

Manuelle Installation

• Local development quickstart – Run MediaWiki locally using PHP and Composer.

Local installation is a good option if you want to set up a simple development environment quickly without using Docker.

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 Manual:Kodierungskonventionen . 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 Gerrit/Anleitung .

Communication tips and guidelines

Beobachte, wie ein Entwickler einen Fehler in der MediaWiki-Erweiterung ausbessert, einschließlich der Untersuchung, dem Übertragen nach git, dem Überprüfen, dem Zusammenführen und dem Schließen von Fällen auf Bugzilla (jetzt von Phabricator ersetzt).

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.
• Do your research: 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.
  • If you have no idea at all how to fix the bug, consider finding an easier one first.
• 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

• Don't ask to ask...just ask!.
• 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:

• Read and follow the code of conduct for Wikimedia technical spaces.
• Use inclusive language : Instead of using terms that assume a gender identity (like "guys", "madam", or "sir") use the name of the person instead.

Ask in the right place

• Ask in public: Do not send private messages if your conversation topic is not secret. Private messages don't help others.
• 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 Kommunikation .
  • 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.

Anhänge

Menschen die an MediaWiki mitwirken, bei der Arbeit in Bangalore, Indien.

PHP

MediaWiki ist in PHP geschrieben. Daher musst du dich mit PHP vertraut machen, um am Kerncode von MediaWiki zu hacken.

PHP lernen

• PHP-Anleitung — Erhältlich in vielen verschiedenen Sprachen. Wenn du kein Wissen über PHP hast, aber in anderen objektorientierten Programmiersprachen programieren kannst, wird PHP für dich 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 maintenance/eval.php in MediaWiki stellt einen grundlegenden PHP Interpreter bereit, in dem MediaWiki-Objekte und Klassen bereits geladen sind.
• Also, the script maintenance/shell.php in MediaWiki is a replacement of maintenance/eval.php based on PsySH, see Handbuch:shell.php

Datenbank

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

Lerne 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-Community.
• Accessing the database

Wissenswertes

• Teste deinen Code mit MySQL/MariaDB.
  • MediaWiki nutzt 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, du versuchst eben, die Unterstützung einer anderen Datenbank zu verbessern. Stelle in diesem Fall sicher, dass du MySQL/MariaDB nicht kaputt machst (oder Abfragen schreibst, 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. Du musst nicht mit JavaScript, jQuery und CSS vertraut sein, um an MediaWiki zu arbeiten, aber es ist möglicherweise notwendig, je nachdem, an was du arbeiten willst.

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

Introduction to MediaWiki core concepts

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

MediaWiki-Überblicksartikel und Pflichtlektüre

• MediaWiki-Architektur — Eine Überblick aus der Vogelperspektive über die Hauptkomponenten von MediaWiki und wie diese zusammenarbeiten.
• Sicherheit für Entwickler — Ein Überblick darüber, warum und wie man sicheren Code schreibt.

Quellen zu MediaWiki

• Manual:Code — Eine Liste der wichtigen Dateien und Links zu weiteren Informationen.
• Handbuch:Hooks — Eine Liste von Hooks. Wenn du versuchst, herauszufinden, welcher Teil des Codes etwas bestimmtes tut, ist es häufig ein guter Ausgangspunkt, nach den entsprechenden Hooks zu suchen.
• Manual:Kodierungskonventionen — Ein Überblick über die allgemeinen Konventionen zum Programmierstil innerhalb der MediaWiki-Gemeinschaft.
• Code-Dokumentation (Klassenreferenz) — Automatisch aus dem Code und den Codekommentaren erstellte Dokumentation.
• Handbuch:Wie man debuggt — Eine Anleitung für das Beheben von Fehlern in MediaWiki.
• Handbuch:eval.php — Ein Werkzeug, um live mit MediaWiki Objekten zu interagieren.

MediaWiki-Erweiterungen

Introduction to MediaWiki extensions

Wenn du am Code von MediaWiki-Erweiterungen arbeiten willst, 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

• Best practices 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

Handbuch:Wie man eine Benutzeroberfläche für MediaWiki erstellt is helpful if you choose to work on MediaWiki skins.

Siehe auch

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

Footnotes