How to become a MediaWiki hacker

This article is written to help novice developers learn the skills needed to contribute to MediaWiki development.

If you are an experienced developer, visit the  instead.

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

It runs on most operating systems, is written in PHP, primarily uses the MySQL database server and uses jQuery as the client JavaScript library.

Development of MediaWiki is primarily supported by the Wikimedia Foundation, though volunteer community developers play a huge part as well.

This page should help you get started on the path to becoming a contributor to MediaWiki.

It is not a tutorial; it just points you to various places where you can go learn whatever is necessary.

Get started
First of all, get  and gerrit>Special:MyLanguage/Gerrit/Tutorial|Gerrit tutorial done to download our code, test it and start 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>Special:MyLanguage/MediaWiki-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)

Manual installation

 * req>Special:MyLanguage/Manual:Installation requirements|Installation requirements — Check hardware requirements, and install a LAMP, MAMP or WAMP server (Linux, Mac or Windows, plus Apache, MySQL and PHP).


 *  — Download the latest source code from Git.


 *  — Continue with the installation and initial configuration


 * Set up the debug>Special:MyLanguage/Manual:How to debug|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 meta>m:data dumps|get a dump.

Suggested reading


General recommendations
If you choose to work on a bug report that requires writing or changing code, you might want to at least skim these pages first:




 * The two main paths to get started with MediaWiki development are to fix an bugs>Special:MyLanguage/annoying little bugs|annoying little bug in the existing code, or to add a new feature, usually through a MediaWiki extension.


 * convention>Special:MyLanguage/Manual:Coding conventions|Coding conventions and any subpages relevant to your task (<tvar|php></>, <tvar|js></>, <tvar|python></>, …)

Hence there is no need anymore to add a "Please review" comment in the report.
 * Following the guidelines>Special:MyLanguage/Gerrit/Commit message guidelines</>|Commit message guidelines, especially the example>Special:MyLanguage/Gerrit/Commit_message_guidelines#Example</>|Example section at the bottom, will automatically add a notification about your patch to the corresponding report in <tvar|phab></>.


 * Check your code against the checklist>Special:MyLanguage/Manual:Pre-commit checklist</>|pre-commit checklist. Don't skip this step ; you'll be happy you didn't.

Find and add people as potential reviewers of your patch.
 * reviews>Special:MyLanguage/Gerrit/Code_review/Getting reviews</>|Getting code reviews.

Don't create a new Gerrit changeset to fix your previous one!
 * tutorial>Special:MyLanguage/Gerrit/Tutorial#Amending_a_change</>|Amending a change.

<section end="SuggestedReadingGeneral"/> <section begin="FeedbackQuestionsSupport"/>
 * In most cases when working with MediaWiki, you hack>Special:MyLanguage/Do not hack MediaWiki core</>|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.

For example, if you have a problem with Gerrit, the talk>Talk:Gerrit/Tutorial</>|Gerrit discussion page could be a good place to ask.
 * If you have general questions about infrastructure, the architecture>Special:MyLanguage/Manual:MediaWiki architecture</>|software architecture or workflows which are not tied to the specific bug that you want to work on, use generic channels like <tvar|irc></>, ml>Special:MyLanguage/Mailing lists</>|mailing lists, or talk>Special:MyLanguage/Help:Talk pages</>|wiki discussion pages.

"What do I have to do to fix this bug?" is not a [<tvar|url>http://catb.org/~esr/faqs/smart-questions.html#explicit</> 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.
 * If you have a specific question about the bug itself, comment in the corresponding <tvar|phab></> report.

Try to 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.
 * When asking, elaborate what you have tried and found out already, so others can help at the right level.


 * Avoid private email or support requests in our social>Special:MyLanguage/Social media</>|social media channels.

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 drop the question.
 * Please be patient when seeking input and comments.

<section end="FeedbackQuestionsSupport"/> <section begin="CommunicateAssignment"/>
 * Learn more at <tvar|communication></>.

Communicate that you work on a bug
You do not need to be set as the assignee in a bug report or announce your plans before you start working on a bug, but it is welcome.

At the latest when you are close to creating a patch for the bug, it is good to announce in a comment that you are working on it.

Your announcement also helps others to not work on the bug at the same time and duplicate work.

Also note that if a bug report already has a recent link to a patch in Gerrit and has the project "Patch-For-Review" associated, you should choose a different bug to work on instead - avoid duplicating work.

If the 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 try to improve it.

If you stop working on a task you should remove yourself as the assignee of a bug report and reset the assignee to the default assignee, so others know that they can work on the bug report and don't expect you to still work on it.

By communicating early you will get more attention, feedback and help from community members. <section end="CommunicateAssignment"/>

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

MediaWiki extensions primers:

developing>Special:MyLanguage/Manual:Developing extensions</>|Developing extensions — How to write an extension for MediaWiki.

writing>Special:MyLanguage/Writing an extension for deployment</>|Writing an extension for deployment — If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security.

hacker>Special:MyLanguage/How to become a MediaWiki hacker/Extension Writing Tutorial</>|Extension writing tutorial

MediaWiki extensions resources:

list>Special:MyLanguage/List of simple extensions</>|List of simple extensions — A simple way to become more familiar with how extensions work.

[<tvar|youtube>https://www.youtube.com/watch?v=4zlGo-hrnt8</> A brief introduction to MediaWiki extension development] — A video presentation about how to create a MediaWiki extension.

— Covers how to develop an extension for Mediawiki, best practices, and how to engage the Mediawiki community. From February 2011.

special>Special:MyLanguage/Manual:Special pages#Basic special page template</>|Special page template — Add a special page to display some handy information.

extending>Special:MyLanguage/Manual:Extending wiki markup</>|Extending wiki markup — Add a parser hook to modify the content of wikitext.

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

Learn PHP
 * [http://www.php.net/manual/en/tutorial.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 topic at Wikiversity.

PHP resources :
 * [http://www.php.net/manual/en/

The PHP manual ] — Available in many different languages.
 * PHP coding conventions within the MediaWiki community.

Stuff to know :

The script  in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.

Database
Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL.

Learn MySQL
 * [http://dev.mysql.com/doc/refman/5.0/en/tutorial.html

MySQL tutorial ] — From the MySQL 5.0 reference manual.
 * MySQL at Wikibooks.

MySQL resources
 * [http://dev.mysql.com/doc/

MySQL Reference Manuals ] — Available in many different languages.
 * Database coding conventions within the MediaWiki community.

Stuff to know :

Test your code with MySQL.

MediaWiki currently uses MySQL (and compatible ones) as the primary database back-end. It also supports other DBMSes, such as PostgreSQL and SQLite. However, almost all developers use MySQL and don't test other DBs, which consequently break on a regular basis. You're therefore advised to use MySQL 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 (or write queries that are horribly inefficient in it), since MySQL is what everybody else uses.

JavaScript and 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 at Wikibooks.
 * [http://learn.jquery.com/

Getting Started with jQuery ] — A jQuery tutorial.

JavaScript and CSS resources
 * JavaScript coding conventions within the MediaWiki community.
 * CSS coding conventions within the MediaWiki community.

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 are constrained to a small region of code.

MediaWiki primers and must-reads :
 * '''[http://www.aosabook.org/en/mediawiki.html

MediaWiki architecture ]''' — A high-level overview of the main components of MediaWiki and how they work with each other.

An overview of why and how to write secure code.

MediaWiki resources :

A list of important files and links to more detailed information.

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.

An overview of general coding conventions within the MediaWiki community.
 * [[How to become a MediaWiki hacker/Workshop|

Intro-to-MediaWiki workshop syllabus ]] — Ways to hack MediaWiki, from user preferences to extensions and core.
 * [https://doc.wikimedia.org/

Code documentation ] — Automatically generated documentation from the code and code comments.

A guide to debugging MediaWiki.

A tool to interact with MediaWiki objects live.