How to become a MediaWiki hacker/bg

Тази статия е написана с цел да помогне на разработчиците да придобият основните умения, нужни за допринасяне към развитието на МедияУики. Имайте предвид, че в повечето случаи, когато работите с MediaWiki, вие не искате да хакнете ядрото на МедияУики, освен ако наистина не знаете какво правите.

The main path to get started with Wikimedia development is to contribute to Wikimedia projects that offer mentoring. An alternative without mentoring is to fix a good first bug.

Ако сте опитен разработчик, който вече е запознат с употребата на МедияУики, вместо това по-добре посетете .

За други начини как да се включите в Wikimedia общността, вижте 

Преглед
МедияУики е софтуера зад Уикипедия, сродните й проекти и хиляди уикита по света.

MediaWiki is written in the PHP programming language. It uses jQuery as the client JavaScript library.

MediaWiki is primarily written for the LAMP platform and runs on most operating systems. MediaWiki primarily uses the MySQL or MariaDB database servers.

Development happens in an open source style, is largely coordinated online, and supported by the Wikimedia Foundation, though volunteer community developers play a huge part as well.

The main developer list is wikitech-l. The main developer IRC channels are #mediawiki and #wikimedia-dev. Follow this tutorial to set up Git and Gerrit in order to submit patches.
 * Development discussion happens on various mailing lists and IRC channels.
 * Source code is managed using the Git revision control system.
 * Code review is performed on.
 * Bug reports and tasks are managed on Phabricator.

Тази страница трябва да ви помогне да започнете пътя си да станете сътрудник на МедияУики. Това не е помощно ръководство; то просто ви насочва към различни места, където можете да научите каквото ви е необходимо.

Set up your development environment
Започнете като се регистрирате за $dev и прочетете ръководството за Gerrit. След това можете да преминете към изтеглянето на нашия код, извършването на промени, тестването им и изпращането на корекции. Има два начина за настройване на вашата среда за разработки: използване на предварително конфигурирана настройка на виртуална машина (vagrant) или ръчно.

Виртуална машина с Vagrant

 * Инсталиране на Vagrant - Тези стъпки ще инсталират МедияУики сървър с всички изисквания в Linux виртуална машина (може да се използва на Linux, Windows или Mac хостове)

Docker development environment

 * MediaWiki Docker – Run MediaWiki using Docker (can be used on Linux, Windows or macOS hosts).

Ръчно инсталиране

 * Изисквания за инсталиране - Проверете изискванията към хардуера и инсталирайте LAMP, MAMP или WAMP сървър (Linux, Mac или Windows, плюс Apache, MySQL/ MariaDB и PHP).


 * - Изтеглете последния изходен код от Git.
 * — Продължете с инсталирането и първоначалната конфигурация
 * Настройте различни режими за отстраняване на грешки във вашата среда, за да показва рано предупреждения и грешки.

Не е необходимо да изтегляте дъмпове с бази данни на Уикимедия, за да се разработвате МедияУики функции. Всъщност в много случаи е по-лесно да се използва почти празна база данни с няколко специално изработени тестови страници. Ако обаче по някаква причина искате да имате копие на Уикипедия, можете да свалите дъмп.

Предложено четиво


Отзиви, въпроси и поддръжка
"Какво трябва да направя, за да отстраня този бъг?" не е добър въпрос за начало: Колкото по-конкретни са вашите въпроси, толкова по-вероятно е някой бързо да може да им отговори. Ако изобщо нямате представа как да отстраните грешката, може би този бъг не е (все още) за вас - моля, първо помислете за намирането на по-лесен. Опитайте се да бъдете конкретни - например, копирайте и поставете вашите команди и резултатите от тях (ако не са твърде дълги), вместо да перифразирате със собствени думи. Това избягва недоразуменията. Do not ask to assign a task to you.
 * От вас се очаква първо да направите някои основни проучвания: Разгледайте кода, опитайте се да разберете какво трябва да направите, прочетете свързаната документация, опитайте се да намерите вероятното място (места), където трябва да направите промени за да поправите грешката.
 * In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
 * Ако имате общи въпроси, които не са обвързани с конкретната задача, по която искате да работите, използвайте общи канали като IRC чат или пощенски списъци, но не и конкретната задача. Questions how to set up your development environment or how to use Gerrit are out of scope for a task.
 * Ако имате конкретен въпрос за самия бъг, коментирайте в съответния доклад на.
 * When asking, explain what you have tried and found out already, so others can help at the right level.
 * Do not ask if you can work on a task.
 * Избягвайте личен имейл или заявки за поддръжка в нашите социални медийни канали.
 * Моля, бъдете търпеливи, когато търсите информация и коментари. В IRC не питайте да попитате, просто попитайте: на повечето въпроси може да се отговори и от други членове на общността, ако попитате в IRC канал. Ако никой не отговори, моля, попитайте на доклада за грешки или страницата на уики, свързана с проблема; не оставяйте просто въпроса.



Комуникирайте, че работите върху бъг
Не е нужно да бъдете поставен като приемник на задачата в доклада за грешка или да обявите плановете си, преди да започнете да работите върху бъга; но би било добре. Do not ask to assign a task to you. You do not need to announce your plans before you start working on a bug, but it would be welcome. You are welcome to set yourself as the assignee in a task: Use the dropdown Add Action… → Assign/Claim in Phabricator. Най-късно може да съобщите в коментар, че работите върху бъга, когато сте близо до създаването на поправката. Вашето съобщение също помага и на другите да не работят едновременно по грешката и да не дублират работата си.

Също така имайте предвид, че ако докладът за грешка има скорошна препратка към пач в Gerrit и е асоцииран с проекта "Patch-For-Review", вместо това трябва да изберете различен бъг - избягвайте дублирането на работата. If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also pick up that existing patch and improve it, based on the feedback in Gerrit and in the task.

If you stop working on a task, remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.

By communicating early you will get more attention, feedback and help from community members.



PHP
МедияУики е написан на PHP, така че ще трябва да се запознаете с PHP, за да се справите с основния код на МедияУики.


 * Научете PHP
 * Ръководство за PHP — Достъпно на много езици. Ако нямате познания за PHP, но знаете как да програмирате на други обектно-ориентирани езици за програмиране, PHP ще бъде лесен за научаване за вас.
 * PHP Programming at Wikibooks.
 * PHP topic at Wikiversity.


 * Ресурси за PHP:
 * Ръководство за PHP — Достъпно на много и различни езици.
 * Конвенции за кодиране в PHP сред общността на МедияУики.


 * Неща, които трябва да знаете:
 * 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 Manual:Shell.php.

База данни
Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL/MariaDB.


 * Научете MySQL/MariaDB
 * Ръководство за MySQL — From the MySQL 5.0 reference manual.
 * MySQL at Wikibooks.


 * Ресурси за MySQL/MariaDB
 * MySQL Reference Manuals — Достъпно на много други езици.
 * База данни на MariaDB
 * Database coding conventions within the MediaWiki community.


 * Неща, които трябва да знаете:
 * Тествайте кода си с 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 и 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.


 * Научете JavaScript и CSS
 * JavaScript and CSS at Wikibooks.
 * Първи стъпки с jQuery — Ръководство за jQuery.
 * Learning JavaScript — references and sources.


 * Ресурси за JavaScript и CSS
 * 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.


 * Ресурси за МедияУики:
 * — Списък на важни файлове и препратки към по-подробна информация.
 * — 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.


 * Документация на кода ( class reference ) — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.

Работа с разширения
Ако решите да работите върху код за разширения на МедияУики, следните препратки предоставят повече информация.


 * Примери за МедияУики разширения:
 * Разработване на разширения — Как да напишете разширение за МедияУики.
 * Extension writing tutorial


 * Ресурси за разширения за МедияУики:
 * 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. От февруари 2011 г.
 * Help for extension developers on the Developer Hub

Вижте също

 * 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.
 * – a collection of related pages