Як стати MediaWiki-хакером

This page is a translated version of the page How to become a MediaWiki hacker and the translation is 10% complete.

This article is written to help developers learn the basic skills needed to contribute to development of MediaWiki core and MediaWiki extensions. Note that in most cases when working with MediaWiki, you do not want to hack MediaWiki core unless you really know what you're doing.

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.

If you are an experienced developer who is familiar with using MediaWiki already, visit the Developer hub instead.

For other ways to get involved in the Wikimedia community, see Як зробити свій внесок .

Огляд

MediaWiki is the software that powers Wikipedia, its sister projects and thousands of wikis all over the world.

Although MediaWiki is written in the PHP programming language, some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python. It uses jQuery as the client JavaScript library.

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

Development happens in an open source style[3], 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 connect and #wikimedia-dev connect.

  • Source code is stored on Gerrit and managed using the Git revision control system and can be viewed here[4]
  • Code review is performed on Gerrit and can be viewed here.

Follow this tutorial to set up Git and Gerrit in order to submit patches.

This page should help you become a contributor to MediaWiki. It is not a tutorial; it just points you to various places where you can go learn whatever is necessary.

Налаштування вашого середовища розробки

Most projects use Git and Gerrit. Follow the Gerrit tutorial to set up your developer account. Then you can move on to downloading our code, making changes, testing them, and submitting patches. There are two ways to set up your development environment: using a pre-configured virtual machine setup (Docker or Vagrant), or a manual configuration approach.

Docker development environment

This is the recommended method.

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

Віртуальна машина з Vagrant

  • Vagrant installation — These steps will install MediaWiki server with all the requirements inside a Linux virtual machine (can be used on Linux, Windows, or Mac hosts).

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.

Ручне встановлення

  • Installation requirements — Check hardware requirements, and install a LAMP, MAMP or WAMP server (Linux, Mac or Windows, plus Apache, MySQL/MariaDB and PHP).

It's not necessary to download Wikipedia database dumps in order to develop MediaWiki features. In fact, in many cases it's easier to use a near-empty database with a few specially-crafted test pages. However, if for some reason you want to have a copy of Wikipedia, you can get a dump.

Communication tips and guidelines

Watch as a developer fixes a bug in a MediaWiki extension, including investigation, git commit, getting it reviewed and merged, and closing the Bugzilla ticket (now replaced by Фабрикатор ).

Користуйтесь цими підказками, щоб спілкуватися ефективно й отримувати допомогу від членів спільноти.

Ефективно користуйтесь завданнями на Фабрикаторі

Коли ви плануєте працювати над завданням на Фабрикаторі:

  • Не треба питати дозволу: Ви можете працювати над нікому не призначеними завданнями без того, щоб вам хтось їх призначав. Немає вищого інстанції, яка призначає завдання або в якої треба спершу спитати.
    • Якщо у завдання є свіжий патч у Gerrit, краще виберіть інше завдання для роботи.
    • Якщо наявний патч у Gerrit не об'єднаний і вже давно не бачив ніяких змін, ви можете покращити цей наявний патч на основі відгуків на Gerrit і в завданні.
  • Проведіть своє дослідження: Коли ви роздумуєте над тим, щоб почати працювати над завданням, проведіть дослідження, перш ніж починати писати код. Погляньте на код, спробуйте зрозуміти, що він має робити, почитайте пов'язану документацію і спробуйте знайти місця, де вам треба буде зробити зміни коду.
    • У завданні на Фабрикатор і, скористайтеся тегами проєктів на бічній панелі, щоб знайти репозиторій коду для цього завдання.
    • Якщо ви взагалі не маєте уявлення, як виправити баг, спробуйте знайти собі легше завдання.
  • Вам не треба оголошувати свої плани, перш ніж починати працювати над завданням, але варто прокомунікувати той факт, що ви над завданням працюєте.
    • Коли ви починаєте працювати, вкажіть себе як виконавця, натиснувши Редагувати завдання… на Фабрикаторі і вказавши своє ім'я користувача на Фабрикаторі у полі Призначено. Це дасть знати іншим, що ви працюєте над завданням, щоб вони не робили ту саму роботу.
    • Коли ваші плани чи інтереси змінилися: Якщо ви більше не працюєте над завданням, приберіть себе з ролі виконавця завдання. Це дасть іншим знати, що вони можуть працювати над завданням і вони не вважатимуть, що ви далі над ним працюєте.
  • Дотримуйтесь етикету Фабрикатора.
    • У завданнях Фабрикатора обговорюйте лише конкретні питання, що стосуються теми завдання. Не використовуйте Фабрикатор для загальних запитань на зразок як налаштувати розробницьке середовище або як вирішити проблеми з Gerrit.

Формулюйте гарні запитання

  • Не просіть спитати… просто питайте!.
  • Будьте чіткі вказуйте контекст: Замість спитати «Можете дати більше інформації?», «Будь ласка, спрямуйте мене» або «Скажіть, будь ласка, де мені почати?», включіть у свої запитання таку інформацію:
    • Чого ви хочете досягти?
    • Що ви уже пробували? Скопіюйте-вставте свої команди і їхній вивід (якщо це не задовго) замість описувати їх своїми словами.
    • Що ви уже виявили, коли досліджували це питання? Включіть посилання на код, документацію чи інші матеріали, з якими ви вже ознайомилися.
  • У своїй комунікації використовуйте конкретні заголовки та теми. «Чернетка пропозиції» чи «Треба допомога» — це не достатньо конкретно.
  • Робіть так, щоб розмова залишалась читабельною: Коли відповідаєте у Zulip, завданнях Фабрикатора чи у списках розсилки, цитуйте лише ті частини попередніх коментарів, які стосуються вашої відповіді. Якщо ви цитуєте попередній коментар повністю, гілку стає важче читати.

Дотримуйтесь політик і найкращих практик комунікації

Перш ніж надсилати чи публікувати своє запитання:

Запитуйте у правильному місці

  • Запитуйте публічно: Не шліть приватних повідомлень, якщо тема вашої розмови не секретна. Приватні повідомлення не допоможуть іншим.
  • Запитуйте й обговорюйте в найкращому місці:
    • У завданнях Фабрикатора обговорюйте лише конкретні питання, що стосуються теми завдання.
    • Загальні технічні запитання, на зразок як налаштувати розробницьке середовище або як вирішити проблеми з Gerrit, ставте у місцях, перелічених на сторінці Спілкування .
    • Якщо ви берете участь в аутріч-програмі, тоді місцем для обговорення самих аутріч-програм є Zulip.

Будьте терплячими

Після того, як ви опублікували своє запитання:

  • Не просіть людей переглянути код окремим повідомленням. Люди отримують сповіщення з Gerrit і Фабрикатора і дадуть відповідь, коли зможуть.
  • Якщо вам треба відгуки і коментарі, особливо на вихідних чи під час свят, можливо, вам треба буде почекати робочого часу. У чатах на зразок IRC: якщо ніхто не відповідає, спробуйте знову в інший час; не здавайтесь просто так!
  • Якщо ви не отримали відповіді навіть будучи терплячими і за якийсь час, спробуйте інші канали комунікації, які можуть бути кращим місцем, де поставити ваше запитання.

Доповнення

 
Учасники MediaWiki за роботою в Бенгалуру, Індія.

PHP

MediaWiki is written in PHP, so you'll need to get familiar with PHP to hack MediaWiki's core.

Learn PHP
  • PHP tutorialAvailable in many different languages. 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 at Wikiversity.
PHP resources
Stuff to know
  • The script maintenance/eval.php in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
  • Also, the script maintenance/shell.php in MediaWiki is a replacement of maintenance/eval.php 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.

Learn MySQL/MariaDB
MySQL/MariaDB resources
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.

Learn JavaScript and CSS
JavaScript and CSS resources

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
MediaWiki resources

Розширення MediaWiki

If you choose to work on MediaWiki extensions code, the following links provide more information.

MediaWiki extensions basics:
MediaWiki extensions resources:

Див. також

  1. MediaWiki runs on most platforms that can support PHP, however, the lack of certain utilities or operating system features may limit the functionality or performance of MediaWiki on non-LAMP platforms.
  2. MediaWiki has support for DBMS other than MySQL and MariaDB, including PostgreSQL, SQLite
  3. Developers are a mix of volunteers and paid staff (or contractors) for various organizations. For a full list of who works on the MediaWiki code, read the Developers article.
  4. Browse the source code and revisions of code repositories at https://phabricator.wikimedia.org/diffusion/ or download the source code to your system by using Gerrit.