How to become a MediaWiki hacker/bg

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

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

Преглед
МедияУики е софтуера зад Уикипедия, сродните й проекти и хиляди уикита по света. Той работи на повечето операционни системи, написан е на PHP, използва предимно сървърите за бази данни MySQL и MariaDB и използва jQuery като клиентска JavaScript библиотека. Разработването на МедияУики се поддържа основно от Фондация Уикимедия, макар че общността от доброволни разработчици също играе огромна роля.

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

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

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

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

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

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

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

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


Основни препоръки
Ако решите да работите върху доклад за грешка, който изисква писане или промяна на код, най-малко може да прочетете тези страници набързо:

 
 * Двата основни начина да започнете с разработването на МедияУики са да поправите съществуващ код или да добавите нова функция, обикновено чрез разширение на МедияУики.
 * Конвенции за кодиране и всички подстраници, свързани с вашата задача (,, ...)
 * Following the Commit message guidelines, especially the Example section at the bottom, will automatically add a notification about your patch to the corresponding report in . Следователно вече няма нужда да добавяте коментар "Моля за преглед" в доклада.
 * Check your code against the pre-commit checklist. Don't skip this step ; you'll be happy you didn't.
 * Getting code reviews. Намерете и добавете хора като потенциални проверяващи на вашия пач.
 * Поправки на изменение. Не създавайте ново изменение на Gerrit, за да поправите предишното!
 * В повечето случаи, когато работите с МедияУики, вие не искате да хакнете ядрото на МедияУики, освен ако наистина не знаете какво правите.

Отзиви, въпроси и поддръжка
 
 * От вас се очаква първо да направите някои основни проучвания: Разгледайте кода, опитайте се да разберете какво трябва да направите, прочетете свързаната документация, опитайте се да намерите вероятното място (места), където трябва да направите промени за да поправите грешката.
 * Ако имате общи въпроси относно инфраструктурата, архитектурата на софтуера или работните потоци, които не са свързани с конкретната грешка, върху която искате да работите; използвайте създадените канали за комуникация като, пощенски списъци или уикибеседите. Например, ако имате проблем с Gerrit, беседата на Gerrit може да бъде подходящо място, на което да попитате.
 * Ако имате конкретен въпрос за самия бъг, коментирайте в съответния доклад на . "Какво трябва да направя, за да отстраня този бъг?" не е добър въпрос за начало: Колкото по-конкретни са вашите въпроси, толкова по-вероятно е някой бързо да може да им отговори. Ако изобщо нямате представа как да отстраните грешката, може би този бъг не е (все още) за вас - моля, първо помислете за намирането на по-лесен.
 * When asking, elaborate what you have tried and found out already, so others can help at the right level. Опитайте се да бъдете конкретни - например, копирайте и поставете вашите команди и резултатите от тях (ако не са твърде дълги), вместо да перифразирате със собствени думи. Това избягва недоразуменията.
 * Избягвайте личен имейл или заявки за поддръжка в нашите социални медийни канали.
 * Моля, бъдете търпеливи, когато търсите информация и коментари. В IRC не питайте да попитате, просто попитайте: на повечето въпроси може да се отговори и от други членове на общността, ако попитате в IRC канал. Ако никой не отговори, моля, попитайте на доклада за грешки или страницата на уики, свързана с проблема; не оставяйте просто въпроса.
 * Научете повече на.

Комуникирайте, че работите върху бъг
Не е нужно да бъдете поставен като приемник на задачата в доклада за грешка или да обявите плановете си, преди да започнете да работите върху бъга; но би било добре. Най-късно може да съобщите в коментар, че работите върху бъга, когато сте близо до създаването на поправката. Вашето съобщение също помага и на другите да не работят едновременно по грешката и да не дублират работата си.

Also note that if a bug report already has a recent link to a patch in Gerrit and has the project "Patch-For-Review" associated, you should choose a different bug to work on instead - avoid duplicating work. If the 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 try to improve it.

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

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

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


 * Примери за МедияУики разширения:
 * Разработване на разширения — Как да напишете разширение за МедияУики.
 * 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.
 * Extension writing tutorial


 * Ресурси за разширения за МедияУики:
 * 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. От февруари 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
МедияУики е написан на PHP, така че ще трябва да се запознаете с PHP, за да се справите с основния код на МедияУики.


 * Научете PHP
 * Ръководство за PHP — Достъпно на много езици. 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:
 * Ръководство за PHP — Достъпно на много и различни езици.
 * 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.

База данни
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.


 * 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 и 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.


 * Ресурси за 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 are constrained to a small region of code.


 * MediaWiki primers 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.
 * — Ways to hack MediaWiki, from user preferences to extensions and core.
 * Документация на кода — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.

Вижте също

 * – 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.
 * – 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.