Bagaimana cara menjadi peretas MediaWiki

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

Artikel ini ditulis untuk membantu para pengembang belajar keterampilan dasar untuk berkontribusi dalam pengembangan inti MediaWiki dan ekstensi MediaWiki. Perhatikan bahwa dalam kebanyakan kasus ketika mengerjakan MediaWiki, Anda jangan meretas inti MediaWiki kecuali Anda tahu apa yang Anda lakukan.

Jalur utama untuk mulai mengikuti pengembangan Wikimedia adalah berkontibusi ke proyek Wikimedia yang menawarkan pendampingan. Cara alternatif tanpa pendampingan adalah dengan memperbaiki sebuah kutu pertama yang baik.

Jika Anda merupakan seorang pengembang berpengalaman yang sudah mengenal MediaWiki, kunjungi Pusat pengembang .

Untuk langkah lain untuk bergabung dengan komunitas Wikimedia, lihat Cara berkontribusi .

Gambaran umum

MediaWiki adalah perangkat lunak yang menenagai Wikipedia, proyek saudaranya dan ribuan wiki di dunia.

MediaWiki ditulis dengan bahasa pemograman PHP[1]. MediaWiki menggunakan jQuery sebagai pustaka JavaScript klien.

MediaWiki ditulis utamanya untuk platform LAMP[2] dan dijalankan di kebanyakan sistem operasi. MediaWiki pada umumnya menggunakan peladen basis data MySQL atau MariaDB.[3]

Pengembangan dilakukan dalam gaya sumber terbuka[4], dikoordinasikan secara daring, dan didukung oleh Yayasan Wikimedia, tetapi komunitas sukarelawan memainkan peran penting juga.

Halaman ini seharusnya membantu Anda menjadi seorang kontributor MediaWiki. Halaman ini bukanlah sebuah tutorial; ini hanya mengarahkan Anda ke berbagai tempat di mana Anda bisa mempelajari semua yang dibutuhkan.

Mengatur lingkungan pengembangan Anda

Kebanyakan proyek menggunakan Git dan Gerrit. Ikuti tutorial Gerrit untuk mengatur akun pengembang Anda. Kemudian Anda bisa mulai mengunduh kode kami, melakukan pengubahan, dan mengajukan tambalan. Ada dua cara untuk mengatur lingkungan pengembangan Anda: menggunakan mesin virtual yang sudah dikonfigurasi (Vagrant atau Docker), atau melakukan konfigurasi manual.

Mesin Virtual dengan Vagrant

  • Pemasangan Vagrant — Langkah-langkah ini akan memasang peladen MediaWiki dengan semua kebutuhannya di dalam sebuah mesin virtual Linux (bisa digunakan di hos Linux, Windows, atau Mac).

Lingkungan pengembangan Docker

  • MediaWiki Docker – Menjalankan MediaWiki menggunakan Docker (bisa digunakan di hos Linux, Windows atau macOS).

Instalasi manual

  • Persyaratan instalasi — Periksa persyaratan perangkat keras, dan pasanglah sebuah peladen LAMP, MAMP atau WAMP (Linux, Mac atau Windows, plus Apache, MySQL/MariaDB dan PHP).
  • Download dari Git — Unduh kode sumber terbaru dari Git.
  • Panduan instalasi — Lanjutkan pemasangan dan konfigurasi awal.
  • Atur berbagai mode awakutu di lingkungan Anda untuk menampilkan peringatan dan galat sejak awal.

Tidak perlu mengunduh dump basis data Wikipedia untuk mengembangkan fitur MediaWiki. Bahkan, dalam banyak kasus lebih mudah menggunakan basis data yang hampir kosong dengan beberapa halaman uji coba yang dibuat khusus. Akan tetapi, jika untuk suatu alasan Anda menginginkan salinan Wikipedia, Anda bisa mendapatkan dump-nya.

Tip dan panduan komunikasi

Saksikan seorang pengembang memperbaiki sebuah kutu di dalam ekstensi MediaWiki, mencakup investigasi, commit git, mendorongnya agar ditinjau dan digabungkan, dan menutup tiket Bugzilla (sekarang digantikan oleh Phabricator ).
  • Do your research first: When you decide to work on a task, you are expected to do some basic research yourself first: Look at the code, try to get some understanding what it is supposed to do, read related documentation, try to find the probable place(s) where you need to make code changes. For a general overview, please read the Basics to know.
    • In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
  • Ask and discuss in the best place:
    • In Phabricator tasks, discuss only specific questions about the topic of that very Phabricator task. General technical questions (e.g. how to set up a development environment or problems with Gerrit) are off-topic in Phabricator tasks.
    • For general technical questions, ask the broader Wikimedia community and use generic channels like IRC chat or mailing lists. (If you take part in an outreach program, then you can also use Zulip's technical-support stream.)
    • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
  • Ask good questions: "Can you give me more info?", "Please guide me", "Please tell me how to start" are not good comments to start with: The more specific your questions are, the more likely somebody can answer them quickly. If you have no idea at all how to fix the bug, maybe that bug is not (yet) for you – consider finding an easier one first.
  • Provide context: When asking, explain what you want to achieve, and what you have tried and found out already, so others can help at the right level. Be specific – for example, copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words. This avoids misunderstandings. Use specific titles and subject lines ("Proposal draft" or "Need help" is not specific).
  • Use inclusive language: Don't assume anyone's gender identity ("guys", "madam", "sir"). Use the name of the person instead.
  • Ask in public: Do not send private messages if your conversation topic is not secret. Private messages do not help others.
  • Be patient when seeking input and comments, especially during weekends and holidays.
    • On IRC, don't ask to ask, just ask: most questions can be answered by other community members too if you ask on an IRC channel. If nobody answers, please try again at a different time; don't just give up.
    • Do not ask people immediately for code review in a separate message. People receive Gerrit and Phabricator notifications.
  • Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, please avoid unneeded quoting of a complete previous comment. Provide sufficient context and keep threads readable.
  • Follow the code of conduct for Wikimedia technical spaces.
  • When you plan to work on a Phabricator task:
    • No need to ask for permission: Usually there is no reason to ask if you can work on something or if somebody could assign a task to you. There is no authority who assigns tasks or who needs to be asked first.
    • You do not need to announce your plans before you start working on a task but it would be welcome. At the latest when you are close to proposing a patch for a task, it is good to announce that you are working on it, so that others don't duplicate work: If nobody else is already assigned, set yourself as task assignee by using the Add Action… → Assign/Claim dropdown.
    • Tasks with existing patches:
      • If a task already has a recent patch in Gerrit, choose a different task to work on instead – avoid duplicating work.
      • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also improve that existing patch, based on the feedback in Gerrit and in the task.
    • When your plans or interests change: If you don't work on a task anymore, please remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.

By communicating clearly and early you get attention, feedback and help from community members.

Apendiks

 
Kontributor MediaWiki bekerja di Bengaluru, India.

PHP

MediaWiki ditulis dalam bahasa PHP, jadi Anda perlu mengenali PHP sebelum meretas inti MediaWiki.

Belajar PHP
  • Tutorial PHP — Tersedia dalam berbagai bahasa. Jika Anda tidak tahu apa-apa tentang PHP tetapi tahu cara memprogram dalam bahasa pemrograman berorientasi objek lainnya, PHP akan mudah untuk dipelajari.
  • PHP Programming at Wikibooks.
  • PHP topic at Wikiversity.
Sumber daya PHP
Hal-hal yang perlu diketahui
  • Skrip maintenance/eval.php di MediaWiki menyediakan sebuah interpreter PHP dasar dengan objek dan kelas MediaWiki sudah dimuat.
  • Juga, skrip maintenance/shell.php di MediaWiki adalah pengganti maintenance/eval.php berdasarkan PsySH, lihat Manual:Shell.php

Basis data

Kebanyakan fitur memerlukan manipulasi basis data, jadi Anda sering kali perlu mengenali MySQL/MariaDB.

Belajar MySQL/MariaDB
Sumber daya MySQL/MariaDB
Hal-hal yang perlu diketahui
  • Uji coba kode Anda dengan MySQL/MariaDB.
    • MediaWiki sekarang sedang menggunakan MySQL dan MariaDB sebagai basis data bagian belakang utama. MediaWiki juga mendukugn DBMS lainnya, seperti PostgreSQL dan SQLite. Akan tetapi, hampir semua pengembang menggunakan MySQL/MariaDB dan tidak menguji DB lainnya sehingga basis data lain kerap mengalami galat. Anda disarankan menggunakan MySQL/MariaDB ketika menguji tambalan, kecuali Anda memang mencoba memperbaiki dukungan untuk DB lainnya. Kalau begitu, berhati-hatilah agar Anda tidak membuat MySQL/MariaDB galat (atau menulis kueri yang tidak efisien dalam mereka), karena MySQL/MariaDB adalah yang digunakan semua orang.

JavaScript dan CSS

JavaScript dan CSS ada di mana-mana di kode bagian depan. Anda tidak harus mengenal JavaScript, jQuery dan CSS untuk mengerjakan MediaWiki, tetapi Anda mungkin perlu, bergantung pada apa yang Anda kerjakan.

Belajar JavaScript dan CSS
Sumber daya JavaScript dan CSS

MediaWiki

Basis kode MediaWiki besar dan beberapa bagiannya tidak cantik; jangan terbebani oleh itu. Ketika Anda memulai, bertujuanlah menulis fitur atau memperbaiki kutu yang hanya menyentuk wilayah kode yang kecil.

Dasar dan bacaan wajib MediaWiki
Sumber daya MediaWiki

Ekstensi MediaWiki

Jika Anda memutuskan untuk mengerjakan kode ekstensi MediaWiki, pranala berikut menyediakan informasi lebih lanjut.

Dasar ekstensi MediaWiki
Sumber daya ekstensi MediaWiki

Lihat pula

  1. Tidak semua MediaWiki ditulis dengan PHP. Beberapa alat dukungan ditulis dalam bahasa lain, termasuk berkas tumpak, skrip shell, makefile dan Python.
  2. MediaWiki berjalan di kebanyakan platform yang mendukung PHP, tetapi, ketidakberadaan utilitas atau fitur sistem operasi tertentu bisa membatasi fungsionalitas atau performa MediaWiki di platform non-LAMP.
  3. MediaWiki punya dukungan untuk DBMS selain MySQL dan MariaDB, termasuk PostgreSQL, SQLite.
  4. Para pengembang merupakan gabungan sukarelawan dan staf (atau kontraktor) yang dibayar dari berbagai organisasi. Untuk daftar lengkap orang yang mengerjakan kode MediaWiki, bacalah artikel $def.
  5. Telusuri kode sumber dan revisi repositori kode di https://phabricator.wikimedia.org/diffusion/ atau unduh kode sumbernya ke sistem Anda menggunakan Gerrit.