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 80% complete.

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

Für andere Möglichkeiten, um sich in der Wikimedia-Gemeinschaft zu engagieren, siehe Wie Sie mithelfen können .

Ü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.
  • Bug reports are filed and projects are coordinated on Phabricator and can be viewed here

Diese Seite soll zeigen, wie man sich zum Projekt MediaWiki beitragen kann. Dies ist kein Lernprogramm, sondern nur eine Liste einiger Punkte, die Sie zu verschiedenen Orten führen, zu denen man hingehen kann, um das zu lernen, was notwendig ist.

Set up your development environment

Die meisten Projekte verwenden Git und Gerrit. Folgen Sie dem Gerrit-Tutorial, um Ihr Entwicklerkonto einzurichten. Danach können Sie fortfahren, um Code herunterzuladen, Änderungen vorzunehmen, diese zu testen und Patches einzureichen. There are two ways to set up your development environment: using a pre-configured virtual machine setup (Docker or Vagrant), or a manual configuration approach.

Docker development environment

  • MediaWiki Docker – Führen Sie MediaWiki aus mit Docker (kann auf Linux, Windows oder macOS als Hauptrechner genutzt werden). This is the recommended method.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker 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 is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.

Manual installation

Es ist nicht notwendig, irgendwelche Wikipedia-Datenbank-Dumps herunterzuladen, um MediaWiki-Funktionen zu entwickeln. Eigentlich reicht es vollkommen, eine fast leere Datenbank mit einigen speziellen Testseiten zu verwenden. Falls doch der Fall der Fälle eintrifft, können Sie sich jederzeit einen Wikipedia- Datenbank-Dump herunterladen.

Communication tips and guidelines

Beobachten Sie, 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, 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
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 Manual:Shell.php

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

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
Quellen zu MediaWiki
  • Manual:Code — Eine Liste der wichtigen Dateien und Links zu weiteren Informationen.
  • Manual:Hooks — 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.
  • Manual:Coding conventions — Ein Überblick über die allgemeinen Konventionen zum Programmierstil innerhalb der MediaWiki-Gemeinschaft.
  • Code-Dokumentation (Klassenreferenz) — Automatisch aus dem Code und den Codekommentaren erstellte Dokumentation.
  • Manual:How to debug — Eine Anleitung für das Debuggen von MediaWiki.
  • Manual:Eval.php — 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
Quellen zu MediaWiki Erweiterungen

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