Wie man ein MediaWiki-Hacker wird

This page is a translated version of the page How to become a MediaWiki hacker and the translation is 71% complete.
Outdated translations are marked like this.

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>. Es wird jQuery als Client-JavaScript-Bibliothek eingesetzt.

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

Die Entwicklung geschieht im Stile von open source. [3] 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 #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[4]
  • 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.

Set up your development environment

You can install and develop MediaWiki on Linux, Windows, or macOS using any of the three solutions below.

Die meisten Projekte verwenden Git und Gerrit. Folge dem Gerrit-Tutorial, um dein Entwicklerkonto einzurichten. Danach können Sie fortfahren, um Code herunterzuladen, Änderungen vorzunehmen, diese zu testen und Patches einzureichen. Es steht dir zwei Möglichkeiten zur Verfügung, um eine Entwicklungsumgebung aufzusetzen: Entweder eine vorkonfigurierte virtuelle Maschine (Docker oder Vagrant) verwenden oder die Entwicklungsumgebung manuell aufsetzen.

Docker

  • MediaWiki Docker – Führe MediaWiki aus mit Docker (kann auf Linux, Windows oder macOS als Hauptrechner genutzt werden).

You can also try the experimental mwcli tool which sets up Docker with a few simple commands and provides basic orchestration functionality for MediaWiki Docker containers. With this you can easily add extensions and features to your container.

If you run it from Windows, Docker shares files between your Windows filesystem and the container filesystem. This can cause MediaWiki to be very slow if you are using WSL2 based engine, due to the poor performance of its shared directory implementation. If you have Windows Pro, you can switch to the Hyper-V backend in the settings of Docker Desktop for better filesystem performance.

An even faster way to run MediaWiki using Docker in Windows (speeds comparable to manually installing) is to clone MediaWiki and run Docker inside WSL (or install and run mwcli inside of WSL). That way there is no shared filesystem overhead. To develop the MediaWiki codebase that is inside the Docker container you can establish a remote connection to it and open the MediaWiki WSL folder in that is in the container using VSCode or PhpStorm.

Virtuelle Maschine mit 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 installing. It runs faster than Docker on Windows, however slower than Docker on WSL or manually installing.

Manuelle Installation

MediaWiki can be developed by installing it natively on your system and editing its code. Installing it natively means it will run faster than Docker or Vagrant, but it will take more time to configure.

  1. Handbuch:Installationsvoraussetzungen Check hardware requirements and install dependencies
  2. Herunterladen von Git — Lade den aktuellsten Quellcode von Git herunter.
  3. Handbuch:Installationsanleitung — Setze dann die Installation und die Erstkonfiguration fort.
  4. * Aktiviere frühzeitig die verschiedenen Debug Varianten in deiner Umgebung, um auf Warnungen und Fehler früher aufmerksam gemacht zu werden.

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:

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
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/MariaDB-Ressourcen
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
Quellen zu JavaScript und CSS

MediaWiki

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

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

Überblicksartikel für MediaWiki-Erweiterungen
Quellen zu MediaWiki Erweiterungen

MediaWiki skins

Manual:How to make a MediaWiki skin is helpful if you choose to work on MediaWiki skins.

Siehe auch

  1. 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.
  2. MediaWiki unterstützt auch andere DBMS abseits von MySQL und MariaDB wie PostgreSQL und SQLite
  3. Die Entwickler sind ein Mix aus Freiwilligen und bezahlten Mitarbeitern (auch externe) verschiedener Organisationen. Eine vollständige Liste der Beitragenden zum MediaWiki-Code findet sich im Artikel Entwickler .
  4. 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.