MediaWikiハッカーになる方法

この記事は開発者を対象に、MediaWiki core と MediaWiki 拡張機能の開発に貢献するために欠かせないスキルの習得を支援する目的で執筆されました。 MediaWiki で活動中、ほんとうに自信があって責任を持てないなら、ほとんどの場合MediaWiki coreをいじらないように注意してください。

ウィキメディアの開発を始めるなら、まずメンターを付けてくれるウィキメディアで貢献することから入りましょう。メンターなしでする他の開発としては、既存のコードにあるgood first bugの修正があります。

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

ウィキメディアのコミュニティに参加するその他の方法は、貢献するには を参照してください。

概要

MediaWiki は、ウィキペディアとその姉妹プロジェクト群や世界中の数多くのウィキを支えるソフトウェアです。

MediaWikiはPHPプログラミング言語により書かれています。 また、クライアントのJavaScript libraryとしてはjQueryを使用しています。

MediaWikiは主にLAMP platform向けに書かれており、ほとんどのOSで実行可能です。 MediaWikiは主にMySQLとMariaDBデータベースサーバを使用しています

開発オープンソーススタイルで行われており、大部分のコミュニケーションはオンライン上で行われています。開発はウィキメディア財団による支援もありますが、ボランティアコミュニティの開発者によるものがかなりの部分を占めています。

• 開発についての議論がさまざまなメーリング リストや IRC チャンネルで行われています。 主要開発者リストはwikitech-lにてご確認ください。 主要開発者IRCチャンネルはMediaWikiやWikimedia-devにてご確認ください。
• ソースコードはw:Gitリビジョン管理システムで管理されています。
• コードレビューは、Gerrit で行われます。 GitやGerritをセットアップしてパッチを送信するには、こちらのチュートリアルをご確認ください。
• バグ報告やタスクは、ファブリケーターで管理されています。

このページは、MediaWikiのコントリビュータになる助けになるはずです。 これはチュートリアルではありません。単に必要なことを学べる場所へのポインタを示しているに過ぎません。

開発環境のセットアップ

ほとんどのプロジェクトでは Git と Gerrit を使用します。Gerrit のチュートリアルにしたがって開発者アカウントを登録してください。 その後に、コードをダウンロードしたり変更、テスト、パッチの送信が可能になります。 開発環境を準備するには、あらかじめ設定された仮想マシン(VagrantもしくはDocker)を使用する方法とマニュアルで行う設定の2通りがあります。

Vagrantを使用した仮想マシン

• Vagrantのインストール - ここに書かれた手順に従えば、Linux仮想マシン内で、MediaWikiサーバーとそれに必要なすべてのプログラムのインストールができます。ホストには、Linux、Windows、Macのいずれも使用可能です。

Docker development environment

• MediaWiki Docker – Run MediaWiki using Docker (can be used on Linux, Windows or macOS hosts).

手動インストール

• インストール要件 - ハードウェア要件を確認し、LAMP、MAMP、WAMP のいずれかのサーバー (Linux、Mac、Windows のいずれかとApache、MySQL/MariaDB、PHP) をインストールします。

• Git からのダウンロード — Git から最新のソースコードをダウンロードします。
• インストール ガイド — 引き続きインストールと初期設定をします。
• 早期に警告やエラーを表示するためにさまざまなデバッグ手段準備します。

MediaWikiの機能開発には、必ずしもウィキペディアのデータベースからダンプをダウンロードする必要はありません。 実際、多くの場合では、いくつかの工夫して作成したテストページを追加したほぼ空のデータベース使用した方が簡単です。 しかし、もし何らかの理由でウィキペディアのコピーが必要な場合は、ここからダンプを入手できます。

おすすめの参考情報

MediaWiki 拡張機能を修正する手順の解説。調査からコミットの獲得、査読を受けたりマージが発生した後、Bugzilla のチケットを終了（現在はPhabricator で手続きする）。

フィードバック、質問、サポート

• 人に質問をする前に、まずは基本的な調査をするべきです。コードを丁寧に読み、そのコードでどんな機能を実行しようとしているのかを考え、関連するドキュメントを読み、バグを修正するのに変更する必要がありそうな箇所の大まかな見当を付ける、といったことを自分自身で行いましょう。
• If you have general questions which are not tied to the specific task that you want to work on, use generic channels like IRC chat or mailing lists but not the specific task.
• If you have a specific question about the bug itself, comment in the corresponding bug report (normally a task in Phabricator ). 「このバグの直し方について、何か情報をもらえますか？」というような質問は、あまりよい質問とは言えません。もっと具体的な質問であれば、誰かから好意的な回答がすぐに返ってくる可能性が高くなるはずです。 バグをどう直したらいいのか全く見当もつかないのであれば、そのバグは（まだ）あなたには向いていないかもしれません。最初はもっと簡単に修正できるバグを探してみてください。
• 質問する時は、他の人が適切なレベルで助けられるように、自分で試してみたことや、検索してみたことを説明するようにしてください。 コメントはより具体的に書いてください。たとえば、コマンドとそれに対する出力内容が合った場合、出力内容を自分の言葉で言い換えるのでなく、（それほど長くなければ）コピー＆ペーストした方が、より具体的になります。 回答する人がそのままの出力結果を見られるようになるため、誤解を避けることができます。
• Do not ask if you can work on a task.
• プライベートなメールを送ったり、MediaWikiのソーシャルメディアチャンネルでのサポートリクエストはやめてください。
• 応答やコメントを受け取るまでは我慢強く待ちましょう。 IRCでは、質問するための質問をせず、単に質問するようにしましょう。IRCチャンネルで質問すれば、他のコミュニティーメンバーからも回答が得られるかもしれません。 回答が全く返ってこなくても、バグ報告か問題に関するウィキページで質問しましょう。諦めてはいけません。

タスクでの仕事を討論する

タスクで作業できる場合は質問しないでください。 バグの作業を始める前に計画を告知する必要はありませんが、していただいてもかまいません。 You are welcome to set yourself as the assignee in a task: Use the dropdown Add Action… → Assign/Claim in Phabricator. 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 contributors at work in Bangalore, India.

PHP

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

Learn PHP

• PHP のチュートリアル — 様々な言語で利用できます。 PHPについて全く知らなくても、他のオブジェクト指向プログラミング言語の経験があれば、PHPを学ぶのは簡単です。
• PHP Programming at Wikibooks.
• PHP topic at Wikiversity.

PHPに関するリソース

• PHPマニュアル — 様々な言語で利用できます。
• MediaWiki コミュニティ内の PHPコーディング規約

知っておくべきこと

• MediaWikiの

maintenance/eval.phpが、基本のPHPインタープリタにMediaWikiのオブジェクトとクラスをロードします。

• Also, the script maintenance/shell.php in MediaWiki is a replacement of maintenance/eval.php based on PsySH, see Manual:Shell.php.

データベース

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

MySQL/MariaDBについて学ぶ

• MySQL のチュートリアル — From the MySQL 5.0 reference manual.
• MySQL at Wikibooks.

MySQL/MariaDB リソース

• MySQL のリファレンス マニュアル — 様々な言語で利用できます。
• MariaDB ナレッジ ベース
• MediaWiki コミュニティ内のデータベース コーディング規約
• Accessing the database

知っておくべきこと

• 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とCSSは、フロントエンドのコードのいたるところに現れます。 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.

JavaScriptとCSSについて学習する

• JavaScript and CSS at Wikibooks.
• jQueryをはじめる — jQuery のチュートリアルです。
• Learning JavaScript — references and sources.

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 only touch a small region of code.

MediaWiki の基本と必読ページ

• MediaWiki のアーキテクチャ — A high-level overview of the main components of MediaWiki and how they work with each other.
• Security for developers — An overview of why and how to write secure code.

MediaWiki のリソース

• Manual:コード — A list of important files and links to more detailed information.
• Manual:フック — 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:コーディング規約 — An overview of general coding conventions within the MediaWiki community.
• コードの説明文書 (class reference) — ソースコードとそれのコメントによって自動生成されています。
• Manual:デバッグの方法 — MediaWikiデバッグの手引。
• Manual:eval.php — A tool to interact with MediaWiki objects live.

MediaWiki 拡張機能

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

MediaWiki extensions basics

• Developing extensions — How to write an extension for MediaWiki.
• 拡張機能の書き方のチュートリアル

MediaWiki 拡張機能のリソース

• 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. 2011年2月からです。
• Help for extension developers on the Developer Hub

関連項目

• Search for code across repositories
• 開発者ハブ – この記事にかかれていることをを精読したら、今度は開発者ハブの情報に移りましょう。
• MediaWiki Developers Guide – a collection of related pages
• 行動規範