How to become a MediaWiki hacker
This article is written to help developers learn the basic skills needed to contribute to development of MediaWiki core and MediaWiki extensions.
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 How to contribute.
- 1 Overview
- 2 Set up your development environment
- 3 Suggested reading
- 4 Appendix
- 5 See also
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.
Set up your development environment
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 (vagrant), or manual.
Virtual Machine with 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)
- Installation requirements — Check hardware requirements, and install a LAMP, MAMP or WAMP server (Linux, Mac or Windows, plus Apache, MySQL/MariaDB and PHP).
- Download from Git — Download the latest source code from Git.
- Installation guide — Continue with the installation and initial configuration
- Set up the various debug modes in your environment to display warning and errors early.
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.
If you choose to work on a bug report that requires writing or changing code:
- The main path to get started with MediaWiki development is to contribute to a Wikimedia project that offers mentoring. An alternative without mentoring is to fix an annoying little bug in the existing code.
- In most cases when working with MediaWiki, you do not want to hack MediaWiki core unless you really know what you're doing.
Feedback, questions and support
- 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 changes in order to fix the bug.
- If you have general questions about infrastructure (Git, Gerrit, Vagrant), the software architecture or workflows which are not tied to the specific task that you want to work on, use generic channels like IRC, mailing lists, or wiki discussion pages but not the specific task. For example, if you have a problem with Gerrit, the Gerrit discussion page could be a good place to ask.
- If you have a specific question about the bug itself, comment in the corresponding bug report (normally a task in Phabricator). "Can you give me more info how to fix this bug?" is not a good question 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 - please consider finding an easier one first.
- When asking, explain 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.
- Avoid private email or support requests in our social media channels.
- Be patient when seeking input and comments. 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 ask on the bug report or wiki page related to the problem; don't just give up.
- Learn more at Communication.
- You can also ask any questions at the weekly Technical Advice IRC Meeting on the #wikimedia-tech channel on Freenode IRC.
Communicate that you work on a task
You do not need to ask if you can work on a task. You do not need to be set as the assignee in a task or announce your plans before you start working on a bug, but it would be welcome. At the latest when you are close to proposing a patch for the task, it is good to announce in a comment that you are working on it. Your announcement helps others to not work on the bug at the same time and to not duplicate work.
Also note that if a task already has a recent link to a patch in Gerrit and has the project "Patch-For-Review" associated in Phabricator, 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 pick up that existing patch and improve it, based on the feedback in Gerrit and in the task.
If you stop working on a task, 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 early you will get more attention, feedback and help from community members.
MediaWiki is written in PHP, so you'll need to get familiar with PHP to hack MediaWiki's core.
- Learn PHP
- PHP resources
- Stuff to know
- The script
maintenance/eval.phpin MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
- The script
Many features require some amount of database manipulation, so you'll often need to be familiar with 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.
- Test your code with MySQL/MariaDB.
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
- Manual:Code — A list of important files and links to more detailed information.
- Manual:Hooks — A list of hooks. If you're trying to find what part of the codebase does something, often a good place to start is by searching for the related hooks.
- Manual:Coding conventions — An overview of general coding conventions within the MediaWiki community.
- Code documentation — Automatically generated documentation from the code and code comments.
- Manual:How to debug — A guide to debugging MediaWiki.
- Manual:Eval.php — A tool to interact with MediaWiki objects live.
If you choose to work on MediaWiki extensions code, the following links provide more information.
- MediaWiki extensions basics
- MediaWiki extensions resources
- Best practices for extensions
- A brief introduction to MediaWiki extension development — A video presentation about how to create a MediaWiki extension (slides).
- Making a MediaWiki extension — Covers how to develop an extension for Mediawiki, best practices, and how to engage the Mediawiki community. From February 2011.
- Help for extension developers on the Developer Hub
- Developer hub – When you've thoroughly read the information in this article, it's time to move on to the information in the developer hub.
- MediaWiki Developers Guide – a collection of related pages
- Code of Conduct