Как стать MediaWiki хакером

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

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

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

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

Обзор

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

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

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

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

• Обсуждение по разработке происходит в различных почтовых рассылках и IRC-каналах. Основной список почтовой рассылки для разработчиков — wikitech-l. Основные IRC-каналы для разработчиков — #mediawiki ^connect и #wikimedia-dev ^connect.

• Исходный код управляется с помощью системы контроля ревизий Git.

• Проверка кода происходит на Gerrit .

Следуйте этому руководству, которое поможет настроить Git и Gerrit для отправки патчей.

• Bug reports (сообщения об ошибках) и задачи управляются с помощью Phabricator.

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

Настройка среды разработки

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

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

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

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers.

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

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

Vagrant is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.

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

• Необходимое ПО — Проверьте аппаратные требования, установите LAMP, MAMP или WAMP (соответственно для Linux, Mac или Windows, а также Apache, MySQL/MariaDB и PHP).
• Скачать из Git — Загрузите последний исходный код из git.
• Руководство по установке — Установите и проведите первоначальную настройку.
• Настройте режимы отладки для раннего отображения предупреждений и ошибок.

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

Советы и рекомендации по коммуникации

Посмотрите за тем как разработчик исправляет баг в расширении MediaWiki, включая исследование, git коммит, проверка изменения и миграция в ветку, закрытие Bugzilla ticket (в настоящее время заменено на Фабрикатор ).

Follow these tips to communicate effectively and get help from community members.

Use Phabricator tasks effectively

When you plan to work on a Phabricator task:

• No need to ask for permission: You can work on unassigned tasks without asking someone to assign them to you. There is no authority who assigns tasks or who needs to be asked first.
  • If a task already has a recent patch in Gerrit, choose a different task to work on instead.
  • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could improve that existing patch, based on the feedback in Gerrit and in the task.
• Do your research: When you consider working on a task, do research before you start coding. Look at the code, try to understand what it is supposed to do, read related documentation, and try to find the places where you need to make code changes.
  • In a Фабрикатор task, use the project tags in the side bar to find the code repository for the task.
  • If you have no idea at all how to fix the bug, consider finding an easier one first.
• You do not need to announce your plans before you start working on a task, but you should communicate that you are working on the task.
  • When you start work, set yourself as task assignee by clicking Edit Task… in Phabricator, and set your Phabricator username in the Assigned To field. This communicates to others that you are working on it, so they don't duplicate work.
  • When your plans or interests change: If you are no longer working on a task, remove yourself as the assignee of the task. This tells others that they can work on the task, and they won't expect you to still work on it.
• Follow Phabricator etiquette.
  • In Phabricator tasks, discuss only specific questions about the topic of that task. Don't use Phabricator to ask general questions, like how to set up a development environment or how to fix problems with Gerrit.

Compose good questions

• Don't ask to ask...just ask!.
• Be specific and provide context: Instead of simply asking "Can you give me more info?", "Please guide me", or "Please tell me how to start", include the following information in your question:
  • What are you trying to achieve?
  • What have you already tried? Copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words.
  • What have you found out already during your research? Include links to code, documentation, or other resources you already consulted.
• Use specific titles and subject lines in your communication. "Proposal draft" or "Need help" is not specific.
• Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, only quote sections of previous comments that are relevant to your response. If you quote a complete previous comment, it makes threads hard to read.

Follow communication policies and best practices

Before you send or post your question:

• Read and follow the code of conduct for Wikimedia technical spaces.
• Use inclusive language : Instead of using terms that assume a gender identity (like "guys", "madam", or "sir") use the name of the person instead.

Ask in the right place

• Ask in public: Do not send private messages if your conversation topic is not secret. Private messages don't help others.
• Ask and discuss in the best place:
  • In Phabricator tasks, discuss only specific questions about the topic of that task.
  • Ask general technical questions, like how to set up a development environment or how to fix problems with Gerrit, in the places listed on Общение .
  • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.

Be patient

After you post your question:

• Do not ask people for code review in a separate message. People receive Gerrit and Phabricator notifications and will respond when they can.
• When seeking input and comments, especially during weekends and holidays, you may need to wait until business hours resume. On chat channels like IRC: if nobody answers, try again at a different time; don't just give up!
• If you don't get an answer even after waiting and being patient, consider if other Communication channels might be a better place to ask your question.

Приложение

Вкладчики в MediaWiki за работой в Бангалоре, Индия.

PHP

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

Учите PHP

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

Источники по PHP

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

Что нужно знать

• Сценарий maintenance/eval.php содержит базовый интерпретатор с объектами и классами MediaWiki.
• Кроме того, сценарий maintenance/shell.php в MediaWiki является заменой кода основанной на PsySH maintenance/eval.php см. 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 — Высокоуровневый обзор основных составляющих MediaWiki и их взаимодействие.
• Безопасность для разработчиков — Почему и как писать безопасный код.

Ресуры МедиаВики

• Manual:Code — Список важных файлов и ссылок на подробную информацию.
• Manual:Hooks/ru — Список перехватов (hooks). Часто, для понимания работы разных частей кодовой базы, полезно найти соответствующий перехват.
• Руководство:Соглашение по кодированию — Обзор основных стандартов оформления кода принятых сообществом MediaWiki.
• Документация кода (ссылка класса) — Автоматически создаваемая документация из кода и комментариев.
• Руководство:Как отлаживать — Руководство по отладке MediaWiki.
• Manual:Eval.php — Инструмент для взаимодействия с объектами MediaWiki.

Расширения MediaWiki

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

Основа MediaWiki расширений

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

Прочие ресурсы

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

См. также

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