Jak zostać hakerem MediaWiki

Ten artykuł został napisany, aby pomóc programistom nauczyć się podstawowych umiejętności potrzebnych do współtworzenia MediaWiki core i rozszerzeń MediaWiki.

Główną ścieżką do rozpoczęcia rozwoju Wikimedia jest przyczynianie się do projektów Wikimedia, które oferują mentoring. Alternatywą bez mentoringu jest naprawienie pierwszego błędu.

Jeśli jesteś doświadczonym programistą, który jest już zaznajomiony z używaniem MediaWiki, zamiast tego odwiedź Developer hub .

Aby poznać inne sposoby zaangażowania się w społeczność Wikimedia, zobacz Jak wnieść wkład .

Przegląd

MediaWiki to oprogramowanie, które obsługuje Wikipedię, jej siostrzane projekty i tysiące wiki na całym świecie.

MediaWiki jest napisane w języku programowania PHP. 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 jest głównie napisane dla platformy LAMP i działa na większości systemów operacyjnych. MediaWiki wykorzystuje przede wszystkim serwery baz danych MySQL i MariaDB.

Oprogramowanie MediaWiki jest rozwijane na licencji open source. Rozwój koordynowany jest online i wspierany przez Wikimedia Foundation, ale dużą rolę pełnią też wolontariusze.

• Dyskusja na temat rozwoju odbywa się na Phabricator , Listy dyskusyjne oraz na kanałach IRC. Główna lista programistów to wikitech-l. Główne kanały IRC dla deweloperów to 1 i 2 dolary.

• Kod źródłowy jest zarządzany za pomocą systemu kontroli wersji Git i można go wyświetlić tutaj

• Przegląd kodu jest wykonywany na Gerrit i można go obejrzeć tutaj. Postępuj zgodnie z tym samouczkiem, aby skonfigurować Gita i Gerrita w celu przesyłania poprawek.
• Zgłoszenia błędów, prośby o funkcje umieszcza się, a projekty koordynuje, w Phabricator i można je przeglądać tutaj

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.

1. Skonfiguruj swoje środowisko programistyczne

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 – Uruchom MediaWiki za pomocą Docker (może być używany w systemach gospodarza Linux, Windows lub macOS).

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

• Instalacja Vagrant — Te kroki zainstalują serwer MediaWiki ze wszystkimi wymaganiami na maszynie wirtualnej z systemem Linux (może być używany na hostach z systemem Linux, Windows lub Mac).

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.

Ręczna instalacja

• Local development quickstart – Run MediaWiki locally using PHP and Composer.

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

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 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.

Create a patch

Finally, to submit your code to be reviewed and added to the repository you are contributing to, follow Gerrit/Tutorial .

Wskazówki i wytyczne dotyczące komunikacji

Zobacz, jak programista naprawia błąd w rozszerzeniu MediaWiki, w tym dochodzenie, zatwierdzenie git, przeglądanie i łączenie oraz zamykanie zgłoszenia w Phabricator .

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 Phabricator 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 Komunikacja .
  • 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.

Dodatki

Współtwórcy MediaWiki w pracy w Bangalore w Indiach.

PHP

MediaWiki jest napisane w PHP, więc musisz zapoznać się z PHP, aby pracować z rdzeniem MediaWiki.

Naucz się PHP

• Samouczek PHP — Dostępny w wielu różnych językach. Jeśli nie znasz języka PHP, ale wiesz, jak programować w innych obiektowych językach programowania, PHP będzie dla Ciebie łatwe do nauczenia.
• PHP Programming at Wikibooks.
• PHP at Wikiversity.

Zasoby PHP

• Podręcznik PHP — Dostępny w wielu różnych językach.
• Konwencje kodowania PHP w społeczności MediaWiki.

Warto wiedzieć

• Skrypt maintenance/eval.php w MediaWiki zapewnia podstawowy interpreter PHP z załadowanymi obiektami i klasami MediaWiki.
• Ponadto skrypt maintenance/shell.php w MediaWiki jest zamiennikiem maintenance/eval.php opartym na PsySH, zobacz Manual:Shell.php

Baza danych

Wiele funkcji wymaga pewnej manipulacji bazą danych, więc często będziesz musiał znać MySQL/MariaDB.

Naucz się MySQL/MariaDB

• Samouczek MySQL — Z podręcznika MySQL.
• MySQL at Wikibooks.

Zasoby MySQL/MariaDB

• Instrukcje obsługi MySQL — Dostępny w wielu różnych językach.
• Baza wiedzy MariaDB
• Konwencje kodowania bazy danych w społeczności MediaWiki.
• Dostęp do bazy danych

Warto wiedzieć

• Przetestuj swój kod za pomocą MySQL/MariaDB.
  • MediaWiki używa obecnie MySQL i MariaDB jako podstawowego zaplecza bazy danych. Obsługuje również inne systemy baz danych, takie jak PostgreSQL i SQLite. Jednak prawie wszyscy programiści używają MySQL/MariaDB i nie testują innych baz danych, które w konsekwencji regularnie się psują. Dlatego zaleca się używanie MySQL/MariaDB podczas testowania łatek, chyba że specjalnie próbujesz poprawić obsługę innej bazy danych. W tym drugim przypadku upewnij się, że uważasz, aby nie zepsuć działania w MySQL/MariaDB (lub nie pisać zapytań, które są w nim strasznie nieefektywne), ponieważ MySQL/MariaDB jest tym, czego używają wszyscy inni.

JavaScript i CSS

JavaScript i CSS stały się wszechobecne w kodzie front-endowym. Nie musisz być zaznajomiony z JavaScript, jQuery i CSS, aby pracować na MediaWiki, ale może być to konieczne - w zależności od tego, nad czym zdecydujesz się pracować.

Naucz się JavaScript i CSS

• JavaScript and CSS at Wikibooks.
• Pierwsze kroki z jQuery — Samouczek jQuery.
• Learning JavaScript — references and sources.

Zasoby JavaScript i CSS

• Konwencje kodowania JavaScript w społeczności MediaWiki.
• Konwencje kodowania CSS w społeczności MediaWiki.

MediaWiki

Baza kodu MediaWiki jest duża, a niektóre części są obrzydliwe - nie daj się tym przytłoczyć. Kiedy zaczynasz, staraj się napisać funkcje lub naprawić błędy, które dotykają tylko małego obszaru kodu.

Podstawy MediaWiki i niezbędne lektury

• Architektura MediaWiki — Ogólny przegląd głównych komponentów MediaWiki i ich wzajemnej współpracy.
• Bezpieczeństwo dla programistów — Omówienie dlaczego i jak pisać bezpieczny kod.

Zasoby MediaWiki

• Manual:Code — Lista ważnych plików i linki do bardziej szczegółowych informacji.
• Podręcznik:Haki — Lista zaczepów (ang. hooks). Jeśli próbujesz znaleźć część kodu, która coś robi, często dobrym miejscem do rozpoczęcia jest wyszukanie powiązanych zaczepów.
• Manual:Coding conventions — Przegląd ogólnych konwencji kodowania w społeczności MediaWiki.
• Dokumentacja kodu (definicja klas) — Automatycznie generowana dokumentacja na podstawie kodu oraz komentarzy do kodu.
• Podręcznik:Jak debugować — Przewodnik debugowania MediaWiki.
• Manual:Eval.php — Narzędzie do interakcji z obiektami MediaWiki na żywo.

Rozszerzenia MediaWiki

Jeśli zdecydujesz się pracować nad kodem rozszerzeń MediaWiki, poniższe łącza zawierają więcej informacji.

Podstawy rozszerzeń MediaWiki

• Developing extensions — Jak napisać rozszerzenie dla MediaWiki.
• Samouczek pisania rozszerzeń

Zasoby rozszerzeń MediaWiki

• Sprawdzone metody dotyczące rozszerzeń
• Krótkie wprowadzenie do rozwoju rozszerzenia MediaWiki — Prezentacja wideo na temat tworzenia rozszerzenia MediaWiki ([slajdy https://wikimania2011.wikimedia.org/wiki/File:Wikimania_2011-_A_brief_introduction_to_MediaWiki_extension_development.pdf]).
• Making a MediaWiki extension — opisuje, jak opracować rozszerzenie dla MediaWiki, najlepsze praktyki i jak zaangażować społeczność MediaWiki. Od lutego 2011.
• Pomoc dla programistów rozszerzeń w Centrum programistów

MediaWiki skins

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

Zobacz też

• Wyszukaj kod w repozytoriach
• Developer hub – Po dokładnym przeczytaniu informacji zawartych w tym artykule nadszedł czas, aby przejść do informacji w centrum deweloperów.
• Code of Conduct

Footnotes