How to become a MediaWiki hacker/ja

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


 * ウィキメディアの開発を始めるなら、まずメンターを付けてくれるウィキメディアで貢献することから入りましょう. メンターなしだと既存のコードにある厄介な小さなバグの修正から手を付けます.

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

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

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

MediaWikiはPHPプログラミング言語により書かれています. また、サイレントJavaScript libraryとしてはjQueryが用いられます.

MediaWiki is primarily written for the LAMP platform and runs on most operating systems. MediaWiki primarily uses the MySQL and MariaDB database servers.

オープンソース形式で進められる開発 is largely coordinated online，ウィキメディア財団によりサポートを受けていますthough volunteer community developers play a huge part as well.

MediaWikiの貢献者にために、このページを役立ててください. これはチュートリアルではありません. ここでは、あなたが必要なことを学ぶことができる場所を示すだけです.
 * 多種のメーリングリストやIRCチャンネルでは開発会議が開かれます. 主要開発者リストはwikitech-lにてご確認ください.  主要開発者IRCチャンネルはMediaWikiやWikimedia-devにてご確認ください.
 * ソースコードはGit更新制御機構を用いて管理されています.
 * Code review is performed on . パッチを修正する順番にてGitやGerritをセッティングする際にはこちらのチュートリアルをご確認ください.
 * バグ報告やタスクはファブリケーターにて管理されています.

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

Vagrant で仮想マシン

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

手動インストール

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

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

推奨する参考情報




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

 * 手順として、まず自力で調べるべきです. コードを細かく見てその機能を考える. 関連する説明文書を読む. その上でバグの修正にはどこを調整すればよいのか、ここじゃないかという箇所を想定してみましょう.
 * 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, 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 ). "このバグの修正方法のさらなる情報をいただけますでしょうか？"というのはあまり望ましい質問とは言えません. もう少し具体的な質問であれば、より好意的に、早く回答が返ってくることでしょう. バグの修正方法に関して全く案が浮かばないのであれば、貴方には向いていないかもしれません. もっと簡単なものを探してみてください.
 * ご質問の際は、他の方が適切なレベルで対応できるようすでに試したり探したりしたことを説明してください. 具体的に - 例としては、私語を含めず（さほど長くなければ）コマンドとそれに対する出力内容のコピー・アンド・ペーストがあります.  これにより誤解を回避できます.
 * 弊社の公共メディアチャンネルでのプライベートEメール，サポートリクエストは避けましょう.
 * Be patient when seeking input and comments. IRCでは、質問に質問しないように. IRCチャンネルで質問することでどの質問も他のコミュニティーメンバーに回答されます. 回答が全くかえってこなければ、バグ報告か問題に関するウィキページで質問しましょう（あきらめてはいけませんよ）.
 * についてもっと詳しくなりましょう.
 * どんな疑問でも、フリーノード IRC の #wikimedia-techチャンネルで開かれる毎週の技術アドバイス・チャットルームで相談できます.



タスクでの仕事を討論する
タスクで作業していれば質問する必要はありません. バグの作業を始める前に方案を知らせる必要はありませんが、していただいてもかまいません. 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. 

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 コミュニティ内のデータベース コーディング規約
 * Accessing the database


 * 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 のチュートリアルです.
 * 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 の基本と必読ページ:
 *  — 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.


 * コードの説明文書 — ソースコードとそれのコメントによって自動生成されています.
 * — MediaWikiデバッグの手引.
 * — 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

関連項目

 * – この記事にかかれていることをを精読したら、今度は開発者ハブの情報に移りましょう.
 * MediaWiki Developers Guide – a collection of related pages