Help:Extension:Translate/翻訳拡張機能の開発を始める
Translate 拡張機能 (翻訳拡張機能) に興味を持ってくださり、ありがとうございます。 この文書の目的は、翻訳拡張機能の開発を簡単に始められる様にすることです。
翻訳拡張機能の開発にはJavaScript/jQueryとCSS/LESSの知識が必要です。 選択したタスクによっては MySQL の知識も必要になる場合があります。
コードを使いこなす
以下のページではコードの概要を紹介していますので参考にしてください:
ローカル開発のセットアップ
Translate 拡張機能の開発を始める最も簡単な方法は、MediaWiki-Docker を使用することです。 こちらの説明書を参照してください。
Translate 拡張機能に特化したコード スニフを実行するには、Translate 拡張機能のディレクトリ内で composer install を実行します。
以下のコマンドを使用できます:
docker-compose exec mediawiki sh -c "cd extensions/Translate && composer install"
コーディング規約
Translate は既存の MediaWiki のコーディング規約に従います。 これらはプログラミング言語によって異なるため、適切なページを確認してください。
Translate に特有の、留意すべきいくつかのその他のガイドラインがあります。
何に取り組むか選択する
Translate Phabricator ボードに移動し、タグ good first tasks が付いたタスクを探してください。
この拡張機能は現在も活発に開発されているため、タスクに取り組む前に、現時点でタスクに反映されていない追加の懸念点についてコメントを残すことを推奨します。
ゴーサインを受け取った後は、タスクを自分に割り当てて作業を開始できます。
パッチ提出チェックリスト
work with Gerrit の操作に慣れておくことが要点です。 またコミットのメッセージ指針を通読して理解することも欠かせません。
パッチの提出前に、準備としてローカルでリント用ツールを走らせて事例をテストしておくこと、簡単な問題を識別して早めに修正しておくことが奨励されます。 コードレビューの段階で行ったり戻ったりする手間を削減するためです。
- ローカルでリントの簡単に修正できる問題を修正するには
phpcbfを走らせます。 実行には次の方法を使います。docker-compose exec mediawiki composer fix extensions/Translate - 自動的に修正できなかった問題を特定するために、他のリンターを実行してください。 実行には次の方法を使います。
docker-compose exec mediawiki sh -c "cd extensions/Translate && composer test" - Translate 拡張機能のテスト ケースを実行してください:
docker-compose exec mediawiki sh -c "composer phpunit:entrypoint -- extensions/Translate/tests/phpunit/"
他の有用なリンク
- MediaWiki コード検索 – 特定のフックや機能が他の拡張機能でどう使われているか調べるのに有効。
- Gerrit の Open パッチ – 査読を手伝ったください。