Help:Extension:Translate/翻訳拡張機能の開発を始める
Translate 拡張機能 (翻訳拡張機能) に興味を持ってくださり、ありがとうございます。 この文書の目的は、翻訳拡張機能の開発を簡単に始められる様にすることです。
翻訳拡張機能の開発にはJavaScript/jQueryとCSS/LESSの知識が必要です。 選択したタスクによっては MySQL の知識も必要になる場合があります。
コードを使いこなす
以下のページではコードの概要を紹介していますので参考にしてください:
ローカル開発のセットアップ
The easiest way to get started with development on Translate extension is to use the MediaWiki-Docker. こちらの説明書を参照してください。
Translate 拡張機能に特化したコード スニフを実行するには、Translate 拡張機能のディレクトリ内で composer install を実行します。
以下のコマンドを使用できます:
docker-compose exec mediawiki sh -c "cd extensions/Translate && composer install"
コーディング規約
Translate follows the existing MediaWiki Coding conventions. These differ based on the programming languages, so ensure you go through the appropriate pages.
There are a few other guidelines specific to Translate to keep in mind.
何に取り組むか選択する
Go to the Translate Phabricator Board and look for tasks with the tag: good first tasks.
Because the extension is actively being worked on, before you start work on a task, we recommend leaving a comment about any additional concerns that are not reflected in the task currently.
After you receive the green light, you can go ahead and assign the task to yourself and start working.
パッチ提出チェックリスト
work with Gerrit の操作に慣れておくことが要点です。 またコミットのメッセージ指針を通読して理解することも欠かせません。
パッチの提出前に、準備としてローカルでリント用ツールを走らせて事例をテストしておくこと、簡単な問題を識別して早めに修正しておくことが奨励されます。 コードレビューの段階で行ったり戻ったりする手間を削減するためです。
- ローカルでリントの簡単に修正できる問題を修正するには
phpcbfを走らせます。 実行には次の方法を使います。docker-compose exec mediawiki composer fix extensions/Translate - Run other linters to identify any issues that could not be fixed automatically. 実行には次の方法を使います。
docker-compose exec mediawiki sh -c "cd extensions/Translate && composer test" - Run Translate extension test cases:
docker-compose exec mediawiki sh -c "composer phpunit:entrypoint -- extensions/Translate/tests/phpunit/"
他の有用なリンク
- MediaWiki コード検索 – 特定のフックや機能が他の拡張機能でどう使われているか調べるのに有効。
- Gerrit の Open パッチ – 査読を手伝ったください。