How to become a MediaWiki hacker/ja

この記事が執筆されたのは、開発の初心者が MediaWiki の開発に貢献するのに必要なスキルを学習するのを支援するためです.

あなたが経験を積んだ開発者である場合は、代わりに  を参照してください.

概要
MediaWiki は、ウィキペディアとその姉妹プロジェクト群や世界中の数多くのウィキを支えるソフトウェアです. 多くのオペレーティング システムで動作します. PHP で書かれており、主に MySQL データベース サーバーを使用し、クライアント側の JavaScript ライブラリとして jQuery を使用します. MediaWikiの開発は主にウィキメディア財団によってサポートされていますが、ボランティアコミュニティの開発者たちもまた大きな役割を果たしています.

このページはMediaWikiの貢献者となるために役立ちます. これはチュートリアルではありません. ここでは、あなたが必要なことを学ぶことができる場所を示すだけです.

始める
First of all, get  and Gerrit tutorial done to download our code, test it and start submitting patches. 開発環境を準備するには、あらかじめ設定された仮想マシン(vagrant)を使用する方法とマニュアルで行う2通りがあります.

Vagrant で仮想マシン

 * Vagrantのインストール - これにより、Linux仮想マシン上でMediaWikiサーバーの準備が完了します(ホストはLinux、Windows、Macいずれも使用可能です)

手動インストール

 * インストール要件 - ハードウェア要件を確認し、LAMP、MAMP、WAMPサーバーをインストールします. (LinuxかMacもしくはWindowsとApache、MySQL/MariaDBとPHP)
 * — Git から最新のソースコードをダウンロードします.
 * — 引き続きインストールと初期設定をします.
 * 早期に警告やエラーを表示するためにさまざまなデバッグ手段準備します.

MediaWikiの機能開発を行うために、Wikipediaデータベースダンプをダウンロードする必要はありません. 実際には、多くの場合いくつかの特別な細工をしたテストページに近い空のデータベースを使用するほうが簡単です. しかしながら、もし何らかの理由でWikipediaのコピーがほしいのならばダンプを入手することができます.

推奨文献


全般的な推奨
コードの作成や変更が必要なバグレポートを作成する場合は、少なくとも次のページを読んでください:

 
 * MediaWikiの開発を開始する場合は、主に、既存のコードの厄介な小さなバグを修正するか、MediaWiki拡張機能を使って新しい機能を追加するという2つの方法があります.
 * コーディング規約とタスクに関連する下位ページ (,, , …)
 * Following the Commit message guidelines, especially the Example section at the bottom, will automatically add a notification about your patch to the corresponding report in . Hence there is no need anymore to add a "Please review" comment in the report.
 * Check your code against the pre-commit checklist. Don't skip this step ; you'll be happy you didn't.
 * Getting code reviews. Find and add people as potential reviewers of your patch.
 * Amending a change. Don't create a new Gerrit changeset to fix your previous one!
 * In most cases when working with MediaWiki, you do not want to hack MediaWiki core unless you really know what you're doing.

フィードバック、質問、サポート
 
 * 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, the software architecture or workflows which are not tied to the specific bug that you want to work on, use generic channels like, mailing lists, or wiki discussion pages. 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 report. "What do I have to do 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, elaborate what you have tried and found out already, so others can help at the right level. 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. これにより誤解を回避できます.
 * Avoid private email or support requests in our social media channels.
 * Please 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 drop the question.
 * についてもっと詳しく知ります.

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

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


 * MediaWiki extensions primers:
 * Developing extensions — How to write an extension for MediaWiki.
 * 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.
 * Extension writing tutorial


 * MediaWiki 拡張機能のリソース:
 * List of simple extensions — A simple way to become more familiar with how extensions work.
 * 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. 2011年2月からです.
 * Special page template — Add a special page to display some handy information.
 * 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
 * PHP のチュートリアル — 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 のリソース:
 * PHP のマニュアル — 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.

データベース
Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL/MariaDB.


 * Learn MySQL/MariaDB
 * MySQL のチュートリアル — From the MySQL 5.0 reference manual.
 * MySQL at Wikibooks.


 * MySQL/MariaDB リソース
 * MySQL のリファレンス マニュアル — Available in many different languages.
 * MariaDB Knowledge Base
 * MediaWiki コミュニティ内のデータベース コーディング規約


 * 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 at Wikibooks.
 * Getting Started with jQuery — jQuery のチュートリアルです.


 * JavaScript と CSS のリソース
 * MediaWiki コミュニティ内の JavaScript コーディング規約
 * MediaWiki コミュニティ内の CSS コーディング規約

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:
 * MediaWiki のアーキテクチャ — 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 のリソース:
 * — 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.
 * — Ways to hack MediaWiki, from user preferences to extensions and core.
 * コードの説明文書 — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.

関連項目

 * – When you've thoroughly read the information in this article, it's time to move on to the information in the developer hub.
 * MediaWiki Virtual Library (MVL) books; this page forms also part of the MediaWiki Developers Guide.
 * MediaWiki Virtual Library (MVL) books; this page forms also part of the MediaWiki Developers Guide.