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.

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, a Special:MyLanguage/MediaWiki on IRC. 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 a žádosti o funkce se ukládají a projekty jsou koordinovány na a lze je zobrazit zde



Nastavte si vývojové prostředí
You can install and develop MediaWiki on Linux, Windows, or macOS using any of the three solutions below.

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.

Docker

 * MediaWiki Docker – spuštění MediaWiki v Docker kontejneru.

Můžete také vyzkoušet experimentální nástroj mwcli, který umožňuje vytvořit Docker kontejner s MediaWiki pomocí několika jednoduchých příkazů a poskytuje také základní orchestrační funkce pro jeho provoz. Díky tomu můžete do kontejneru snadno přidávat rozšíření a funkce.

A pokud jej spustíte v systému Windows, umožní Docker sdílet soubory mezi souborovým systémem systému Windows a souborovým systémem kontejneru. 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 from WSL (or install and run  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.

Vagrant

 * MediaWiki Vagrant – Spustí MediaWiki na linuxovém virtuálním stroji pomocí Vagrantu.

Vagrant umožňuje jedním příkazem spustit MediaWiki instanci, do které lze přidat a následně využít při vývoji až 250+ rozšíření. Vs srovnání s manuální instalací tím ušetříte čas který byste jinak strávili instalací a konfigurací. Běží rychleji než Docker ve Windows, ale pomaleji než když spustíte Docker ve WSL nebo svou manuální instalaci.



Manuální instalace
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)  — Zjistěte nejprve zda-li váš hardware splňuje nároky a doinstalujte vše potřebné ke splnění závislostí.
 * 2)  — stáhněte si nejnovější zdrojový kód z Gitu.
 * 3)  — pokračujte v instalaci a počáteční konfiguraci.
 * 4) Nastavte ve svém prostředí různé režimy ladění, aby se varování a chyby zobrazovaly včas.



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. Pokud nemáte žádné znalosti PHP, ale umíte programovat v jiných objektově orientovaných programovacích jazycích, PHP se snadno naučíte.
 * Programování v PHP na Wikibooks (anglicky).
 * PHP na Wikiversity (anglicky).


 * Zdroje PHP:
 * Příručka PHP — Dostupná v mnoha různých jazycích.
 * Konvence kódování PHP v rámci komunity MediaWiki.


 * Poznání:
 * Skript  v MediaWiki poskytuje základní interpret PHP s načtenými objekty a třídami MediaWiki.
 * Skript  v MediaWiki také nahrazuje skript   založený na PsySH, viz

Databáze
Mnoho funkcí vyžaduje určité množství manipulace s databází, takže často budete muset znát MySQL/MariaDB.


 * Naučte se MySQL/MariaDB
 * Návod MySQL — Z referenční příručky MySQL.
 * MySQL na Wikibooks (anglicky).


 * Zdroje MySQL/MariaDB
 * Referenční příručka MySQL — Dostupná v mnoha různých jazycích.
 * Databáze znalostí MariaDB
 * Konvence kódování databáze v rámci komunity MediaWiki.


 * Poznání:
 * Otestujte svůj kód pomocí MySQL/MariaDB.
 * MediaWiki v současné době používá MySQL a MariaDB jako primární back-end databáze. Podporuje také další DBMS, jako je PostgreSQL a SQLite. Téměř všichni vývojáři však používají MySQL/MariaDB a netestují jiné databáze, které se následně pravidelně porušují. Proto se doporučuje při testování oprav používat MySQL/MariaDB, pokud se konkrétně nesnažíte zlepšit podporu pro jinou DB. V druhém případě se ujistěte, že jste opatrní, abyste nerozbili MySQL/MariaDB (nebo v ní nepsali dotazy, které jsou strašně neefektivní), protože MySQL/MariaDB používají všichni ostatní.



JavaScript a CSS
JavaScript a CSS se staly v kódu front-endu všudypřítomné. Abyste mohli pracovat na MediaWiki, musíte znát JavaScript, jQuery a CSS, ale možná je budete potřebovat, v závislosti na tom, na čem se rozhodnete pracovat.


 * Naučte se JavaScript a CSS
 * JavaScript a CSS na Wikibooks (anglicky).
 * Začínáme s jQuery (anglicky) — Výukový program jQuery.
 * Knihovna — referenční popis k JavaScriptovým knihovnám na MediaWiki


 * Zdroje JavaScriptu a CSS
 * Konvence kódování JavaScriptu v rámci komunity MediaWiki.
 * Konvence kódování CSS v rámci komunity MediaWiki.

MediaWiki
Základ kódu MediaWiki je velký a některé části jsou nevzhledné. Nenech se tím zahltit. Když začínáte, snažte se napsat funkce nebo opravit chyby, které se dotýkají pouze malé oblasti kódu.


 * Základy MediaWiki a povinné čtení:
 *  — Přehled hlavních komponent MediaWiki na vysoké úrovni a jejich vzájemné spolupráce.
 *  — Přehled toho, proč a jak psát bezpečný kód.


 * Zdroje MediaWiki:
 * — Seznam důležitých souborů a odkazy na podrobnější informace.
 * — Seznam háčků. Pokud se snažíte zjistit, která část kódové základny něco dělá, často je dobré začít hledáním souvisejících háčků.
 * — Přehled obecných konvencí kódování v rámci komunity MediaWiki.


 * Dokumentace kódu (odkaz na třídu) — Automaticky generovaná dokumentace z kódu a komentářů ke kódu.
 * — Průvodce laděním MediaWiki.
 * — Nástroj pro živou interakci s objekty MediaWiki.



Rozšíření MediaWiki
Pokud se rozhodnete pracovat s kódem rozšíření MediaWiki, další informace poskytnou následující odkazy.


 * Základy rozšíření MediaWiki:
 * Vývoj rozšíření — Jak napsat rozšíření pro MediaWiki.
 * Výukový program pro psaní rozšíření


 * Zdroje rozšíření MediaWiki:
 * Doporučené postupy pro rozšíření
 * Stručný úvod do vývoje rozšíření MediaWiki — Videoprezentace o tom, jak vytvořit rozšíření MediaWiki (slides).
 * Vytvoření rozšíření MediaWiki — Vysvětluje, jak vyvinout rozšíření pro MediaWiki, osvědčené postupy a jak zapojit komunitu MediaWiki. Od února 2011.
 * Nápověda pro vývojáře rozšíření ve Vývojářském centru



Související odkazy

 * Hledejte kód napříč repozitáři
 * – Pokud jste si důkladně přečetli informace v tomto článku, je čas přejít k informacím ve vývojářském centru.