MediaWikiハッカーになる方法

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page How to become a MediaWiki hacker and the translation is 58% complete.

Other languages:
العربية • ‎български • ‎বাংলা • ‎dansk • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎magyar • ‎interlingua • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Nederlands • ‎occitan • ‎ਪੰਜਾਬੀ • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎српски / srpski • ‎svenska • ‎ไทย • ‎Türkçe • ‎Tiếng Việt • ‎中文

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

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

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

概要

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

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

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

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

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

開発の環境設定

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

Vagrant で仮想マシン

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

手動インストール

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

推奨する参考情報

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


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

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


付録

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 のチュートリアル — 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 のリソース
Stuff to know
  • The script maintenance/eval.php 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/MariaDB リソース
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 と 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 のリソース

MediaWiki 拡張機能

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

MediaWiki extensions basics
MediaWiki 拡張機能のリソース

関連項目

  1. MediaWikiの全部がPHPで書かれている訳ではありません。多少の補助ツールはまた他の言語で書かれており、batch filesMakefilePythonも含まれます。
  2. MediaWiki runs on most platforms that can support PHP, however, the lack of certain utilities or operating system features may limit the functionality or performance of MediaWiki on non-LAMP platforms.
  3. MediaWiki has support for DBMS other than MySQL and MariaDB, including Oracle, PostgreSQL, SQLite, and Microsoft SQL Server.
  4. 開発者は様々なオルガナイゼーション用のボランティアや雇用スタッフ(あるいはコンストラクター)の集まりです。MediaWikiコードに基づいて働く人々の完全な一覧はDevelopersDevelopersの記事をご覧ください。
  5. ソースコードの表示やコードリポジトリの更新はhttp://phabricator.wikimedia.org/diffusion/ で行うかGerritを用いてお使いのシステムにソースコードをダウンロード。