How to become a MediaWiki hacker/ru

Эта статья поможет разработчикам обрести базовые навыки, необходимые для участия в разработке MediaWiki ядра и MediaWiki расширений.

Чтобы начать разработку Wikimedia, основное, с чего нужно начать, это вносить вклад в проекты Wikimedia в которых есть наставничество. В качестве альтернативы (без наставничества) можно исправлять небольшие раздражающие ошибки.

Если вы уже опытный разработчик и хорошо знакомы с особенностями MediaWiki, посетите .

Чтобы участвовать в развитии Wikimedia по другим направлениям, смотрите .

Обзор
MediaWiki — это программное обеспечение, на основе которого создана Википедия, её родственные проекты, а также тысячи вики по всему миру.

Хотя MediaWiki написана на языке программирования PHP, некоторые вспомогательные утилиты написаны на других языках, включая пакетные файлы, сценарии командной строки, makefiles и Python.

Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python.

MediaWiki изначально написана для платформы LAMP и работает в большинстве операционных систем. MediaWiki изначально использует сервера баз данных MySQL или MariaDB.

Разработка ведется в стиле открытого исходного кода, в основном координируется онлайн и поддерживается Wikimedia Foundation. Тем не менее волонтеры, сообщество, разработчики также играют огромную роль.


 * Обсуждение по разработке происходит в различных, и IRC-каналах. Основной список почтовой рассылки для разработчиков — wikitech-l. Основные IRC-каналы для разработчиков —  и.
 * Исходный код хранится в и управляется с помощью системы контроля ревизий Git и может быть просмотрен здесь
 * Проверка кода происходит на и может быть просмотрена [gerrit:q/project:mediawiki/core|здесь]. Следуйте этому руководству, которое поможет настроить Git и Gerrit для отправки патчей.
 * Bug reports (сообщения об ошибках) и запросы функций подаются, а проекты согласовываются в и могут быть просмотрены здесь

Find or create a task
Before you ever develop a feature or fix a bug in a MediaWiki project, it is important that you do your research about it. This includes:


 * 1) Search Phabricator if an open or closed Task (Document Types field) already exists. If it doesn't, create one. If this is a very small change, don't create one.
 * 2) Find and investigate the code that needs to be changed to implement the feature. Comment your findings on the Phabricator Task if they might be helpful to others who implement it or review your changes.
 * 3) Determine if you can likely add the feature or fix the bug based the code you investigated and the changes needed. If the task is large or complex, you should find something easier and work your way up to eventually be able to handle tasks of that size. If you believe you can complete it, assign yourself to the Task and begin working on it.



Настройка среды разработки
Once you have found something you can work on, the next step to developing MediaWiki or an extension is creating an environment to run MediaWiki, its database, and any other external features so that you can develop and test them.

You can install and develop MediaWiki on Linux, Windows, or macOS using any of the three solutions below.

Docker

 * MediaWiki Docker - запуск MediaWiki при помощи Docker.

Docker is a good option if you want to setup a MediaWiki installation quickly and are not planning on installing many extensions.

Вы также можете попробовать экспериментальный инструмент mwcli, который настраивает Docker с помощью нескольких простых команд и предоставляет базовые функции оркестрации для контейнеров MediaWiki Docker.

Vagrant

 * Установка Vagrant — Установка сервера MediaWiki со всем необходимым внутри виртуальной машины Linux (возможно использование Linux, Windows или Mac хостов)

Vagrant позволяет вам запускать экземпляр MediaWiki, который вы можете разрабатывать, а также позволяет вам добавлять и разрабатывать любое из 250+ расширений — и все это с помощью одной команды.

Это экономит время на установку и настройку по сравнению с установкой вручную.



Самостоятельная установка
MediaWiki can be developed by installing it and its dependencies locally on your system.

It will take much more time to set up than Docker or Vagrant.


 * 1)  — Проверьте требования к оборудованию и установите зависимости
 * 2)  — Загрузите последний исходный код из git.
 * 3)  — Установите и проведите первоначальную настройку.
 * 4) * Настройте режимы отладки для раннего отображения предупреждений и ошибок.

Open a code editor
The two recommended code editors for editing MediaWiki are VSCode and PhpStorm. VSCode is free and PhpStorm is paid, however, you can acquire a PhpStorm license for free if you are a student by linking your GitHub Education account to your JetBrains account, or by requesting a license granted to Wikimedia.

To determine which editor you should install and use, know that all-around, PhpStorm has more and more-powerful features than VSCode. However, PhpStorm takes significantly longer to load on start than VSCode as it builds an index of the entire repository whereas VSCode progressively loads. Therefore, VSCode is typically useful for file-viewing sessions or small changes and PhpStorm for larger changes. It makes sense to have both installed for these reasons.

To develop the MediaWiki codebase that is inside a Docker container you can establish a remote connection to it and open the MediaWiki folder inside it using VSCode or PhpStorm.

Change and test the code
Change the code and view your changes by reloading your MediaWiki browser tab. Make sure to follow. Write and run tests on your code to make sure it works and is formatted properly.

Note, you can save time by ensuring your changes will be accepted before taking the time to write tests. Create a patch without needed tests and ask for someone to review it stating that you will add tests after they review it.

Create a patch
Finally, to submit your code to be reviewed and added to the repository you are contributing to, follow.



PHP
MediaWiki написан на PHP, соответственно он необходим для работы над ядром MediaWiki.


 * Учите PHP
 * Учебник PHP — Доступен на многих языках. Если вы не знаете PHP, но умеете программировать на других объектно-ориентированных языках программирования, то изучение PHP для вас будет несложным.
 * Программирование на PHP в Викиучебнике.
 * PHP в Викиверситете.


 * Источники по PHP:
 * Руководство PHP — Доступно на многих языках.
 * Стандарты оформления PHP кода, используемые сообществом MediaWiki.


 * Что нужно знать:
 * Скрипт  содержит базовый интерпретатор с объектами и классами MediaWiki.
 * Кроме того, скрипт  в MediaWiki является заменой кода основанной на PsySH , см.

Базы данных
Зачастую необходимы знания базы данных MySQL/MariaDB.


 * Учите MySQL/MariaDB
 * Учебник MySQL — Из справочного руководства для MySQL.
 * MySQL в Викиучебнике.


 * Материалы по MySQL/MariaDB
 * MySQL справочные материалы — Доступны на многих языках.
 * База знаний MariaDB
 * Оформление кода баз данных в сообществе MediaWiki.


 * Что нужно знать:
 * Тестируйте код с MySQL/MariaDB.
 * MediaWiki использует MySQL and MariaDB в качестве основных баз данных. Также поддерживаются и другие СУБД, такие как PostgreSQL и SQLite. Однако почти все разработчики используют MySQL/MariaDB и проводят тесты только используя их, вследствие этого другие базы данных при тестах часто выходят из строя. Поэтому, если вы целенаправленно не занимаетесь улучшением поддержки для других баз данных, то используйте MySQL/MariaDB. Если да, то убедитесь в правильности работы с MySQL/MariaDB (и в эффективности запросов), так как их используют почти все остальные разработчики.



JavaScript и CSS
JavaScript и CSS стали стандартом в разработке фронтенда. Вы не должны быть знакомы с JavaScript, jQuery и CSS для разработки MediaWiki, но соответствующие знания могут понадобиться.


 * Учите JavaScript и CSS
 * JavaScript и CSS в Викиучебнике.
 * Начнём обучение jQuery — Учебник jQuery.
 * Изучение JavaScript — ссылки,сноски и источники.


 * Материалы по JavaScript и CSS
 * Оформление JavaScript кода в сообществе MediaWiki.
 * Оформление CSS кода в сообществе MediaWiki.

MediaWiki
Кодовая база MediaWiki достаточно велика и местами трудна для понимания, не перестарайтесь. Начинайте работать над исправлениями ошибок или создавайте новые возможности так, чтобы затрагивался только небольшой участок кода.


 * Материалы MediaWiki, необходимые к прочтению:
 *  — Высокоуровневый обзор основных составляющих MediaWiki и их взаимодействие.
 *  — Почему и как писать безопасный код.


 * Ресуры MediaWiki:
 * — Список важных файлов и ссылок на подробную информацию.
 * — Список перехватов (hooks). Часто, для понимания работы разных частей кодовой базы, полезно найти соответствующий перехват.
 * — Обзор основных стандартов оформления кода принятых сообществом MediaWiki.


 * Документация кода (ссылка класса) — Автоматически создаваемая документация из кода и комментариев.
 * — Руководство по отладке MediaWiki.
 * — Инструмент для взаимодействия с объектами MediaWiki.



Расширения MediaWiki
Если вы хотите работать над кодом расширений MediaWiki, следующие ссылки могут помочь вам в работе.


 * Основа MediaWiki расширений:
 * Разработка расширений — Как написать расширение для MediaWiki.
 * Руководство по разработке расширения


 * Прочие ресурсы:
 * Лучшие практики
 * Короткое введение в разработку расширений — Видео-презентация (слайды).
 * Создаём расширение MediaWiki — Статья о разработке, лучшие практиках, участии в жизни сообщества. Февраль 2011 года.
 * Помощь разработчикам расширений на портале разработчиков (Developer Hub).

MediaWiki skins
is helpful if you choose to work on MediaWiki skins.



См. также

 * Поиск кода в репозиториях
 * – Если вы усвоили весь материал статьи, то время переходить к порталу разработчиков.