How to become a MediaWiki hacker/cs

Tento článek je napsán, aby pomohl vývojářům naučit se základní dovednosti potřebné k tomu, aby přispěli k vývoji jádra MediaWiki a rozšíření MediaWiki. Všimněte si, že ve většině případů při práci s MediaWiki nechcete hacknout jádro MediaWiki, pokud opravdu nevíte, co děláte.

Hlavní cestou, jak začít s vývojem Wikimedie, je přispívat do projektů Wikimedie, které nabízejí mentoring. Alternativou bez mentoringu je opravit dobře první chybu.

Pokud jste zkušený vývojář, který už je obeznámen s používáním MediaWiki, navštivte místo toho .

Další způsoby, jak se zapojit do komunity Wikimedie, najdete na stránce .

Přehled
MediaWiki je software, na kterém běží Wikipedie, její sesterské projekty a tisíce dalších wiki po celém světě.

Přestože je MediaWiki napsána v PHP programovacím jazyce, některé podpůrné nástroje jsou napsány v jiných jazycích, včetně dávkových souborů, shell skriptů, makefiles a Python. Jako klientskou knihovnu JavaScript používá jQuery.

MediaWiki je primárně psána pro platformu LAMP a běží na většině operačních systémů. MediaWiki primárně používá databázové servery MySQL nebo MariaDB.

Vývoj probíhá ve stylu otevřeného zdroje. Je do značné míry koordinován online a je podporován nadací Wikimedia Foundation. I když vývojáři dobrovolnických komunit hrají také velkou roli.


 * Diskuse o vývoji probíhá na různých emailových konferencích a IRC kanálech. Hlavní seznam vývojářů je wikitech-l. Hlavní vývojářské IRC kanály jsou a.
 * Zdrojový kód je uložen na a spravován pomocí systému kontroly revizí Git a lze jej zobrazit zde
 * Recenze kódu se provádí na a lze ji zobrazit zde. Postupujte podle tohoto návodu a nastavte Git a Gerrit za účelem odesílání záplat.
 * Hlášení o chybách se ukládají a projekty jsou koordinovány na a lze je zobrazit zde

Tato stránka by vám měla pomoci stát se přispěvatelem do MediaWiki. Není to návod. Jen vás nasměruje na různá místa, kde se můžete naučit, co je potřeba.



Nastavte si vývojové prostředí
Většina projektů používá Git a Gerrit. Postupujte podle návodu Gerritu a nastavte si svůj vývojářský účet. Poté můžete přejít ke stažení našeho kódu, provádění změn, jejich testování a odesílání oprav. Existují dva způsoby, jak nastavit vývojové prostředí: Pomocí předkonfigurovaného nastavení virtuálního stroje (Docker nebo Vagrant) nebo pomocí ruční konfigurace.



Vývojové prostředí Docker

 * MediaWiki Docker – spusťte MediaWiki pomocí Dockeru (lze použít na hostitelích Linux, Windows nebo macOS). This is the recommended method.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers. 

Virtuální stroj s Vagrantem

 * Instalace Vagrant — tyto kroky nainstalují server MediaWiki se všemi požadavky uvnitř virtuálního počítače Linux (lze použít na hostitelích Linux, Windows nebo Mac).

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.



Ruční instalace

 * Požadavky na instalaci — zkontrolujte hardwarové požadavky a nainstalujte server LAMP, MAMP nebo WAMP (Linux, Mac nebo Windows plus Apache, MySQL/MariaDB a PHP).
 * — stáhněte si nejnovější zdrojový kód z Gitu.
 * — pokračujte v instalaci a počáteční konfiguraci.
 * Nastavte ve svém prostředí různé režimy ladění, aby se varování a chyby zobrazovaly včas.

Pro vývoj funkcí MediaWiki není nutné stahovat výpisy databáze Wikipedie. Ve skutečnosti je v mnoha případech snazší použít téměř prázdnou databázi s několika speciálně vytvořenými testovacími stránkami. Pokud však z nějakého důvodu chcete mít kopii Wikipedie, můžete získat výpis.



PHP
MediaWiki je napsána v PHP, takže se budete muset seznámit s PHP, abyste mohli hacknout jádro MediaWiki.


 * Naučte se PHP
 * návod PHP — Dostupné v mnoha různých jazycích. 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 at Wikiversity.


 * PHP resources :
 * The PHP manual — Available in many different languages.
 * PHP coding conventions within the MediaWiki community.


 * Stuff to know :
 * The script  in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
 * Also, the script  in MediaWiki is a replacement of   based on PsySH, see

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


 * Learn MySQL/MariaDB
 * MySQL tutorial — From the MySQL reference manual.
 * MySQL at Wikibooks.


 * MySQL/MariaDB resources
 * MySQL Reference Manuals — Available in many different languages.
 * MariaDB Knowledge Base
 * Database coding conventions within the MediaWiki community.


 * Stuff to know :
 * Test your code with MySQL/MariaDB.
 * MediaWiki currently uses MySQL and MariaDB as the primary database back-end. It also supports other DBMSes, such as PostgreSQL and SQLite. However, almost all developers use MySQL/MariaDB and don't test other DBs, which consequently break on a regular basis. You're therefore advised to use MySQL/MariaDB 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/MariaDB (or write queries that are horribly inefficient in it), since MySQL/MariaDB is what everybody else uses.

JavaScript and CSS
JavaScript and CSS have become omnipresent in front-end code. You don't have to be familiar with JavaScript, jQuery and CSS to work on MediaWiki, but you might need to, depending on what you choose to work on.


 * Learn JavaScript and CSS
 * JavaScript and CSS at Wikibooks.
 * Getting Started with jQuery — A jQuery tutorial.
 * Learning JavaScript — references and sources.


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

MediaWiki
The MediaWiki code base is large and some parts are ugly; don't be overwhelmed by it. When you're first starting off, aim to write features or fix bugs which only touch a small region of code.


 * MediaWiki basics and must-reads :
 *  — A high-level overview of the main components of MediaWiki and how they work with each other.
 *  — An overview of why and how to write secure code.


 * MediaWiki resources :
 * — A list of important files and links to more detailed information.
 * — 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.


 * Code documentation ( class reference ) — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.

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


 * MediaWiki extensions basics:
 * Developing extensions — How to write an extension for MediaWiki.
 * Extension writing tutorial


 * MediaWiki extensions resources:
 * Best practices for extensions
 * 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. From February 2011.
 * Help for extension developers on the Developer Hub



Viz též

 * Search for code across repositories
 * – When you've thoroughly read the information in this article, it's time to move on to the information in the developer hub.