How to become a MediaWiki hacker/de



Dieser Artikel soll noch unerfahrenen EntwicklerInnen helfen, die notwendigen Fähigkeiten zu erwerben, um zur MediaWiki-Entwicklung beitragen zu können.

Wenn Sie ein/e erfahrene/r EntwicklerIn sind, besuchen Sie stattdessen .

Überblick
MediaWiki ist die Software, welche Wikipedia, ihre Schwesterprojekte und Tausende von Wikis in der ganzen Welt antreibt. MediaWiki läuft unter den meisten gängigen Betriebssystemen, ist geschrieben in PHP, verwendet primär MySQL Datenbanken und jQuery als Javascript Library für den Browser. Die Entwicklung von MediaWiki wird in erster Linie von der Wikimedia Foundation unterstützt, obwohl freiwillige Community-EntwicklerInnen eine große Rolle spielen.

Diese Seite soll Ihnen zeigen, wie man sich am besten in das Projekt MediaWiki einbringen kann. Es ist kein Lernprogramm, es sind nur Punkte, die Sie zu verschiedenen Orten führen, wo man hingehen kann, um das zu lernen was notwendig ist.

Erste Schritte
Zuallererst, lies dir  und das Tutorial von Gerrit  durch, bevor du mit dem Runterladen, Testen und Einreichen von Patches beginnst. Dir stehen zwei Möglichkeiten zur Verfügung, um deine Entwicklungsumgebung aufzusetzen: Entweder verwendest du eine vorkonfigurierte virtuelle Maschine (Vagrant) oder du setzt die Entwicklungsumgebung selbststäntig auf.

Virtuelle Maschine mit Vagrant

 * Installation von Vagrant - Eine Step by Step Erklärung für die Installation eines MediaWiki Servers auf einer Linux VM, welche unter Linux, Windows oder Mac OS verwendet werden kann

Manuelle Installation

 * Installationsvorausetzungen - Überprüfe bitte zuerst die Handwarevoraussetzungen und installiere dann einen LAMP, MAMP oder WAMP Server (Linux, Mac oder Windows, inklusive Apache, MySQL und PHP)
 * - Lade den aktuellsten Quellcode von Git herunter
 * - Setze dann mit der Installation und der Erstkonfiguration fort
 * Aktiviere frühzeitig die verschiedenen Debug Varianten in deiner Umgebung um auf Warnungen und Fehler aufmerksam gemacht zu werden

Es ist überhaupt nicht notwendig irgendwelche Wikipedia Datenbank Auszuüge zu generieren, um MediaWiki Features zu erstellen. Eigentlich reicht es vollkommen, eine fast leere Datenbank mit einigen speziellen Testseiten zu verwenden. Falls doch der Fall der Fälle eintrifft, kannst du dir jederzeit einen Wikipedia Datenbank Auszug runterladen.

Nachlesen


Allgemeine Empfehlungen
Solltest du an einem Bug Report arbeiten, welcher es nötig macht bestimmten Sourcecode zu schreiben oder zu ändern, solltest du diese Seite unbedingt zuerst lesen:


 * Es gibt zwei empfohlene Wege um mit dem Entwickeln für MediaWiki zu beginnen. Entweder behebt man einen kleinen Bug im bereits bestehendem Code, oder man fügt neue Features hinzu, am besten über eine MediaWiki Erweiterung.
 * Coding conventions und alle Unterseiten zu Ihrer Aufgabe (,, , ...)
 * Im Anschluss an die  ' Commit Meldung Richtlinien' , insbesondere die Beispiel Abschnitt an der Unterseite, wird automatisch eine Benachrichtigung über Ihr Pflaster zu dem entsprechenden Bericht in $ phab hinzuzufügen. Daher gibt es keine Notwendigkeit mehr , um eine " Bitte bewerten Sie" Kommentar in dem Bericht hinzuzufügen.
 * Check your code against the pre-commit checklist. Don't skip this step ; you'll be happy you didn't.

 
 *  Anreise Code-Reviews  . Suchen und Personen hinzufügen, wie potentielle Rezensenten Ihrer Patch.
 * Zur Änderung eine Änderung Erstellen Sie nicht eine neue Gerrit Changeset zu Ihrer vorherigen fix!
 * In den meisten Fällen bei der Arbeit mit MediaWiki, können Sie wollen nicht hacken MediaWiki Kern , wenn Sie wirklich wissen, was du tust.

Feedback, Fragen und Unterstützung

 * Es wird erwartet, einige grundlegende Forschung selbst zuerst zu tun: Blick auf den Code, versuchen, ein gewisses Verständnis, was es tun soll, lesen Sie die zugehörige Dokumentation, versuchen, das wahrscheinlich ist, Location (s), wo Sie brauchen, um Änderungen in der Bestellung zu machen finden um den Fehler zu beheben.
 * Wenn Sie allgemeine Fragen über die Infrastruktur verfügen, die Software-Architektur oder Workflows, die nicht auf die spezifische Bug gebunden sind, die Sie bearbeiten, verwenden Sie Einzelkanäle wie  möchten, Mailinglisten  oder Wiki Diskussionsseiten . Zum Beispiel, wenn Sie ein Problem mit Gerrit haben , die Gerrit Diskussionsseite  könnte ein guter Ort, um zu bitten.

 
 * Wenn Sie eine bestimmte Frage über die Fehler selbst zu haben, einen Kommentar in dem entsprechenden Bericht . " Was muss ich tun, um diese Fehler zu beheben ? " ist kein gute Frage, mit zu beginnen : Je genauer Sie Ihre Fragen sind , desto wahrscheinlicher jemand sie schnell zu beantworten. Wenn Sie keine Ahnung haben überhaupt , wie man den Fehler zu beheben , dass Fehler ist vielleicht (noch) nicht für Sie - bitte zunächst der Suche nach einer leichteren.
 * Bei der Frage, auszuarbeiten , was Sie versucht und schon herausgefunden haben , so dass andere auf der richtigen Ebene zu helfen. Versuchen Sie, um genau zu sein - zum Beispiel, kopieren und fügen Sie Ihre Befehle und deren Ausgang (wenn nicht zu lang) statt paraphrasieren in Ihren eigenen Worten . Dies vermeidet Missverständnisse.
 * Vermeiden Sie private E-Mail oder Support-Anfragen in unserer Social Media Kanäle.
 * Bitte haben Sie Geduld bei der Suche nach Eingabe und Kommentare. Im IRC, fragen Sie nicht zu fragen , fragen Sie einfach : die meisten Fragen können durch andere Mitglieder der Community beantwortet werden auch, wenn Sie auf einem IRC-Kanal zu fragen. Wenn niemand antwortet, bitten Sie auf der Fehlerbericht, oder Wiki-Seite, um dem Problem zu tun; nicht werfen Sie einfach die Frage.
 * Erfahren Sie mehr unter.

Kommunizieren Sie, dass Sie an einem Fehler umzug
Sie brauchen nicht, die als Rechtsnachfolger in einem Fehlerbericht eingestellt oder bekannt zu geben Ihre Pläne , bevor Sie an einem Fehler beginnen werden, aber es ist willkommen.

Spätestens dann, wenn Sie in der Nähe, um die Schaffung eines Patch für den Fehler sind , ist es gut, in einem Kommentar, dass Sie daran arbeiten zu verkünden.

Ihre Ankündigung hilft auch anderen, nicht auf dem Bug arbeiten zur gleichen Zeit und doppelte Arbeit.

Beachten Sie auch, dass, wenn ein Fehlerbericht bereits über eine aktuelle Verbindung zu einem Patch in Gerrit und hat das Projekt "Patch -For- Bewertung " verbunden sind, sollten Sie einen anderen Bug wählen zu arbeiten statt - Überschneidungen mit der Arbeit. Wenn der Patch in Gerrit hat nicht zusammengeführt worden und hat keine Änderungen für eine lange Zeit zu sehen, können Sie auch abholen , dass bestehende Patch und versuchen, es zu verbessern.

Wenn Sie die Arbeit an einer Aufgabe, sollten Sie sich als Rechtsnachfolger der einen Fehlerbericht zu entfernen und setzen Sie die Anmelderin auf den Standardnachfolger, so dass andere wissen, dass sie auf der Bug-Report arbeiten und erwarten nicht, dass Sie immer noch daran zu arbeiten.

Durch die Kommunikation früh werden Sie mehr Aufmerksamkeit, Feedback zu bekommen und Hilfe von Community-Mitgliedern.



Die Arbeit an Erweiterungen
If you choose to work on MediaWiki extensions code, the following links provide more information.


 * MediaWiki extensions primers:
 * Developing extensions — How to write an extension for MediaWiki.
 * Writing an extension for deployment — If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security.
 * Verlängerung schriftlich Tutorials


 * MediaWiki -Erweiterungen Informationen:
 * List of simple extensions — A simple way to become more familiar with how extensions work.
 * A brief introduction to MediaWiki extension development — A video presentation about how to create a MediaWiki extension (slides).
 * Making a MediaWiki extension — Covers how to develop an extension for Mediawiki, best practices, and how to engage the Mediawiki community. Ab Februar 2011.
 * Special page template — Add a special page to display some handy information.
 * Extending wiki markup — Add a parser hook to modify the content of wikitext.

PHP
MediaWiki is written in PHP, so you'll need to get familiar with PHP to hack MediaWiki's core.


 * Lernen PHP
 * PHP -tutorial — Erhältlich in vielen verschiedenen Sprachen. If you have no knowledge of PHP but know how to program in other object-oriented programming languages, PHP will be easy for you to learn.
 * PHP Programming at Wikibooks.
 * PHP topic at Wikiversity.


 * PHP ressourcen:
 * Das PHP Handbuch — Erhältlich in vielen verschiedenen Sprachen.
 * PHP coding conventions within the MediaWiki community.


 * Stuff zu wissen:
 * The script  in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.

Datenbank
Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL.


 * Lernen MySQL
 * MySQL lernprogramm — Aus dem ReferenzhandbuchMySQL 5.0.
 * MySQL at Wikibooks.


 * MySQL ressourcen
 * MySQL Referenzhandbücher — Erhältlich in vielen verschiedenen Sprachen.
 * Database coding conventions within the MediaWiki community.


 * Stuff zu wissen:
 * Testen Sie Ihren Code mit MySQL.
 * MediaWiki currently uses MySQL (and compatible ones) as the primary database back-end. It also supports other DBMSes, such as PostgreSQL and SQLite. However, almost all developers use MySQL and don't test other DBs, which consequently break on a regular basis. You're therefore advised to use MySQL when testing patches, unless you're specifically trying to improve support for another DB. In the latter case, make sure you're careful not to break MySQL (or write queries that are horribly inefficient in it), since MySQL is what everybody else uses.

JavaScript and CSS
JavaScript und CSS geworden sind allgegenwärtig in Front-End-Code. Sie können haben zu sein mit JavaScript, jQuery und CSS vertraut auf MediaWiki arbeiten, aber Sie vielleicht benötigen, je nachdem, was Sie sich entscheiden zu arbeiten.


 * Lernen JavaScript and CSS
 * JavaScript and CSS at Wikibooks.
 * Erste Schritte mit jQuery Schritte — A jQuery tutorial.


 * JavaScript and CSS ressourcen
 * JavaScript coding conventions within the MediaWiki community.
 * CSS coding conventions within the MediaWiki community.

MediaWiki
Die MediaWiki -Codebasis ist groß und einige Teile hässlich ; nicht von ihr überwältigt werden.

Wenn man gerade angefangen ab, zielen darauf ab, Funktionen schreiben oder Fehler zu beheben, die auf einen kleinen Bereich des Codes beschränkt sind.


 * MediaWiki -Primer und Must-liest:
 * MediaWiki architektur — Ein High-Level- Überblick über die Hauptkomponenten der MediaWiki und wie sie miteinander zu arbeiten.
 *  — Ein Überblick, warum und wie , um einen sicheren Code zu schreiben.


 * MediaWiki ressourcen:
 * — Eine Liste der wichtigen Dateien und Links zu weiteren Informationen.
 * — A list of hooks. If you're trying to find what part of the codebase does something, often a good place to start is by searching for the related hooks.
 * — An overview of general coding conventions within the MediaWiki community.
 * Intro-to-MediaWiki workshop syllabus — Ways to hack MediaWiki, from user preferences to extensions and core.
 * Code documentation — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.

Siehe auch

 * "Learn how to hack MediaWiki" workshop
 * – When you've thoroughly read the information in this article, it's time to move on to the information in the developer hub.
 * MediaWiki Virtual Library (MVL) books; this page forms also part of the MediaWiki Developers Guide.
 * How to become a MediaWiki hacker/Volunteer achievements – Volunteer developers have been responsible for most MediaWiki software