How to become a MediaWiki hacker/ru

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

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

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

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

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

MediaWiki написана на языке PHP. Использует jQuery в качестве клиента к библиотеке JavaScript.

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

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

Данная статья поможет вам стать вкладчиком в MediaWiki. Это не учебник. Здесь лишь указаны источники, из которых вы можете почерпнуть необходимые сведения.
 * Обсуждение по разработке происходит в различных почтовых рассылках и IRC-каналах. Основной список почтовой рассылки для разработчиков — wikitech-l. Основные IRC-каналы для разработчиков — #mediawiki и #wikimedia-dev.
 * Исходный код управляется с помощью системы контроля ревизий Git.
 * Проверка кода происходит на . Следуйте этому руководству, которое поможет настроить Git и Gerrit для отправки патчей.
 * Bug reports (сообщения об ошибках) и задачи управляются с помощью Phabricator.

Настройка среды разработки
В большинстве проектов используются Git и Gerrit. Следуйте инструкциям в руководстве по Gerrit, чтобы создать и настроить свою учётную запись разработчика. Затем загрузите исходный код, вносите изменения, тестируйте, предлагайте исправления. Есть два способа настроить окружение разработчика: использование уже настроенной виртуальную машину (Vagrant или Docker) или настроить всё вручную.

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

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

Окружение разработчика в docker

 * MediaWiki Docker - запуск MediaWiki при помощи docker (можно использовать на Linux, Windows или MacOS хостах).

Самостоятельная установка

 * Необходимое ПО — Проверьте аппаратные требования, установите LAMP, MAMP или WAMP (соответственно для Linux, Mac или Windows, а также Apache, MySQL/MariaDB и PHP).


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

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

Рекомендуется прочесть


Обратная связь, вопросы и поддержка
Наберитесь терпения в ожидании отзывов и комментариев. В чате IRC на большинство вопросов ответят такие же участники как и вы. Если ответа нет, спросите баг отчете или на соответствующей странице вики, не оставляйте свой вопрос без ответа. 
 * Предполагается, что для начала вы сделаете некоторые базовые исследования: исследуйте на код; попробуйте понять что он делает; прочитайте документацию; попробуйте найти вероятное место(а) где необходимо внести изменения, чтобы исправить ошибку.
 * 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.
 * Для конкретных вопросов о самом баге используйте комментарии в отчете . "Можете ли вы дать больше информации о том как исправить ошибку?", - не самый лучший вопрос. Подробность и детальность в вопросе помогут получить ответ быстрее. Правильно оценивайте свои способности на данный момент и не пытайтесь исправлять баг, который вам совершенно не понятен. Выберите другой, который проще для вас.
 * Отметьте в своём вопросе ваши наработки и идеи, чтобы другие понимали на каком этапе в решении проблемы вы находитесь. Будьте конкретны. Например, скопируйте ваши команды и хи вывод (если их не слишком много) вместо их словесного описания. Это поможет избежать недопонимания.
 * Do not ask if you can work on a task.
 * Используйте наши социальные медиа, не скрывайте email.

Сообщите о том, что работаете над задачей
Не нужно спрашивать можно ли вам работать над заданием. Вам не нужно объявлять свои планы, прежде чем приступать к работе над ошибкой, но это будет весьма полезно. Вы можете указать себя как ответственного за задачу: используйте выпадающее меню Add Action… → Assign/Claim в Phabricator. В последствии, при создании патча, сообщите о своей работе в комментарии. Ваше объявление поможет другим не работать над ошибкой в одно и то же время и не дублировать работу.

Также обратите внимание, что если в задаче уже есть ссылка на патч в Gerrit и есть проект "Patch-For-Review", связанный с Phabricator, выберите другую задачу для работы - избегайте дублирования работы. Если патч в Gerrit не был принят и не изменялся в течении длительного времени, то вы также можете взять этот патч и улучшить его, учитывая обратную связь на Gerrit и в задаче.

Если вы прекращаете работу над задачей, удалите отметку о себе как об ответственном (assignee) за задачу, чтобы остальные участники могли заняться задачей, зная, что вы оставили свою работу над ней.

Чем раньше начнёте взаимодействовать с другими участниками, тем больше внимания и помощи получите. 

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


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


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


 * Что нужно знать:
 * Сценарий  содержит базовый интерпретатор с объектами и классами MediaWiki.
 * Also, the script  in MediaWiki is a replacement of   based on PsySH, see Manual:Shell.php.

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


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


 * Материалы по 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 and CSS at Wikibooks.
 * Начнём обучение jQuery — Учебник jQuery.
 * Learning JavaScript — references and sources.


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

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


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


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


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

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


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


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

Смотрите также

 * Search for code across repositories
 * – Если вы усвоили весь материал статьи, то время переходить к порталу разработчиков.
 * – a collection of related pages