MediaWiki

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

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

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

Contributing to MediaWiki is often difficult, so if you would like to get involved with Wikimedia development instead, you should 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.

Most of MediaWiki and extensions are written in the PHP programming language. JavaScript is used for providing interactive interface elements along with jQuery and Vue.js as client JavaScript libraries.

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

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.

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

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

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

You can also try the mwcli tool which sets up Docker with a few simple commands and provides basic orchestration functionality between MediaWiki, MySQL, ElasticSearch, Memcached, and other types of containers.

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

Vagrant allows you start a MediaWiki instance you can develop as well as allowing you to add and develop any of 250+ extensions - all with a single command.

This saves you installation and configuration time compared to manually adding extensions in a Docker or local installation, but it runs a bit slower than the other two options.

Локальна установка

Local installation is a good option if you want to set up a simple development environment quickly without using Docker.

Відкрийте редактор коду

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 the code and view your changes by reloading your MediaWiki browser tab. Make sure to follow Manual:Coding conventions . 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.

Створіть патч

Finally, to submit your code to be reviewed and added to the repository you are contributing to, follow Gerrit/Посібник .

Поради та рекомендації щодо спілкування

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 tutorial — Available 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

Introduction to MediaWiki core concepts

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

Introduction to MediaWiki extensions

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

MediaWiki extensions basics:
MediaWiki extensions resources:

Скіни МедіаВікі

Manual:How to make a MediaWiki skin is helpful if you choose to work on MediaWiki skins.

Див. також

Виноски

  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.
Retrieved from "https://www.mediawiki.org/w/index.php?title=How_to_become_a_MediaWiki_hacker/uk&oldid=6754367"