MediaWikiハッカーになる方法

From mediawiki.org
This page is a translated version of the page How to become a MediaWiki hacker and the translation is 97% complete.
Outdated translations are marked like this.

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

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

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

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

概要

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

MediaWiki は PHP プログラミング言語で書かれていますが、一部の補助ツールは他の言語で書かれています。バッチ ファイルMakefilePython などがその例です。 また、クライアントのJavaScript ライブラリとしては jQuery を使用しています。

MediaWiki は主に LAMP プラットフォーム向けに書かれており[1]、ほとんどの OS で実行可能です。 MediaWiki は主に MySQL または MariaDBデータベース サーバーを使用しています[2]

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

  • ソースコードGit リビジョン管理システムで管理されています。[4]
  • バグ報告やタスクは、こちらで閲覧できます。

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

開発環境のセットアップ

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

Docker 開発環境

  • MediaWiki DockerDockerを使用してMediaWikiを実行します。(Linux、Windows、macOSのホストで使用可能)。 This is the recommended method.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers.

Vagrantを使用した仮想マシン

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

Vagrant is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.

手動インストール

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

コミュニケーションのヒントとガイドライン

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

Follow these tips to communicate effectively and get help from community members.

Use Phabricator tasks effectively

When you plan to work on a Phabricator task:

  • No need to ask for permission: You can work on unassigned tasks without asking someone to assign them to you. There is no authority who assigns tasks or who needs to be asked first.
    • If a task already has a recent patch in Gerrit, choose a different task to work on instead.
    • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could improve that existing patch, based on the feedback in Gerrit and in the task.
  • Do your research: When you consider working on a task, do research before you start coding. Look at the code, try to understand what it is supposed to do, read related documentation, and try to find the places where you need to make code changes.
    • In a Phabricator task, use the project tags in the side bar to find the code repository for the task.
    • If you have no idea at all how to fix the bug, consider finding an easier one first.
  • You do not need to announce your plans before you start working on a task, but you should communicate that you are working on the task.
    • When you start work, set yourself as task assignee by clicking Edit Task… in Phabricator, and set your Phabricator username in the Assigned To field. This communicates to others that you are working on it, so they don't duplicate work.
    • When your plans or interests change: If you are no longer working on a task, remove yourself as the assignee of the task. This tells others that they can work on the task, and they won't expect you to still work on it.
  • Follow Phabricator etiquette.
    • In Phabricator tasks, discuss only specific questions about the topic of that task. Don't use Phabricator to ask general questions, like how to set up a development environment or how to fix problems with Gerrit.

Compose good questions

  • Be specific and provide context: Instead of simply asking "Can you give me more info?", "Please guide me", or "Please tell me how to start", include the following information in your question:
    • What are you trying to achieve?
    • What have you already tried? Copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words.
    • What have you found out already during your research? Include links to code, documentation, or other resources you already consulted.
  • Use specific titles and subject lines in your communication. "Proposal draft" or "Need help" is not specific.
  • Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, only quote sections of previous comments that are relevant to your response. If you quote a complete previous comment, it makes threads hard to read.

Follow communication policies and best practices

Before you send or post your question:

Ask in the right place

  • Ask in public: Do not send private messages if your conversation topic is not secret.

Private messages don't help others.

  • Ask and discuss in the best place:
    • In Phabricator tasks, discuss only specific questions about the topic of that task.
    • Ask general technical questions, like how to set up a development environment or how to fix problems with Gerrit, in the places listed on コミュニケーション .
    • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.

Be patient

After you post your question:

  • Do not ask people for code review in a separate message. People receive Gerrit and Phabricator notifications and will respond when they can.
  • When seeking input and comments, especially during weekends and holidays, you may need to wait until business hours resume. On chat channels like IRC: if nobody answers, try again at a different time; don't just give up!
  • If you don't get an answer even after waiting and being patient, consider if other Communication channels might be a better place to ask your question.

付録

インドのバンガロールで作業するMediaWikiのコントリビューターたち。

PHP

MediaWikiはPHPで書かれています。ですから、MediaWikiのコアをハックするためにPHPに精通する必要があります。

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

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

  • また、MediaWikiのスクリプトmaintenance/shell.phpの書き換えも必要。maintenance/eval.phpがベースです。special:mylanguage/Manual:Shell.phpも参照してください。

データベース

多くの機能がある程度のデータベース操作を必要とするため、MySQL/MariaDBに精通している必要がある場合が多いでしょう。

MySQL/MariaDBについて学ぶ
MySQL/MariaDB リソース
知っておくべきこと
  • MySQL/MariaDBでコードをテストしてください。
    • MediaWiki は現在、主要なデータベースバックエンドとして MySQLMariaDB を使用しています。 また、PostgreSQLSQLiteなどの他のDBMSもサポートしています。 しかし、ほとんどすべての開発者はMySQL/MariaDBを使用しており、他のDBをテストしていないため、結果として定期的に動かなくなっていまいます。 そのため、パッチのテストには、特に他のDBのサポートを改善する場合を除き、MySQL/MariaDBを使用することをお勧めします。 後者の場合、MySQL/MariaDB を壊さないように(あるいは、MySQL/MariaDB において恐ろしく非効率なクエリを書かないように)注意してください。

JavaScript と CSS

JavaScriptとCSSは、フロントエンドのコードのいたるところに現れます。 MediaWikiで作業するためにJavaScript、jQuery、CSSに精通する必要はありませんが、作業する内容によっては必要かもしれません。

JavaScriptとCSSについて学習する
JavaScript と CSS のリソース

MediaWiki

MediaWikiのコードベースは大きな部分もあります; それに圧倒されないでください。 最初のうちは、コードの小さな領域にしか触れないような機能を書いたり、バグを修正したりすることを目標にしましょう。

MediaWiki の基本と必読ページ
MediaWiki のリソース

MediaWiki 拡張機能

MediaWikiの拡張機能のコードを動かす事を選んだなら、以下のリンクから詳細をご覧いただけます。

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

関連項目

  1. MediaWikiはPHPをサポートする殆どのプラットフォームで実行可能ですが、LAMP以外のプラットフォーム上では、特定のユーティリティやOSの機能がないために機能や性能が制限される場合があります。
  2. MediaWiki は MySQLMariaDB 以外の DBMS もサポートします。例えば、PostgreSQLSQLite です。
  3. 開発者は、ボランティアや様々な組織で働いているスタッフ(あるいは契約者)の集団からなります。MediaWikiのコードに対してコントリビュートしている開発者の全リストについては、開発者 の記事をご覧ください。
  4. ソースコードを閲覧したり、コードリポジトリを更新するには http://phabricator.wikimedia.org/diffusion/ を訪問してください。Gerritを用いてシステムにソースコードをダウンロードすることもできます。