開発への協力

Jetpack に協力してみませんか

Jetpack をもっと強固で安全なものにするための力になれるということをご存じでしょうか。Jetpack をご使用中で、Jetpack が大好きなら、プロジェクトに協力してみませんか。

(Jetpackをご使用でないなら、ためらう必要はありません。いますぐダウンロードしましょう。)

WordPress そのものと同様に、Jetpack はオープンソースです。計画された改善をテストしたり、コードやファイルやバグレポートを調査したり、自作のパッチを提出することすらできます。コミュニティーの協力は、WordPress と Jetpack をとても強いものにするのです。

Jetpack に協力すると、実際の操作性を改善し、数百万のサイトの機能を改善させることになります。特に、開発者の方は、どのレベルの方でも協力することができます。かろうじてフィルタのことがわかるかどうか (または、その意味を知らなくても) 、あるいはこれまでにプラグインを自作したことがあるかどうかにかかわらず、協力する方法はあります。さあ、始めましょう。

初心者・中級者・上級者のための貢献オプション

裏庭ロケット: Jetpack の新米ユーザー

Jetpack のことがわかってきましたでしょうか。ようこそ。

最初に、テストサイトに Jetpack をインストールし、いろいろと設定します。いくつかのモジュールを有効にし、カスタマイズしてみましょう。(どこから始めればいいかわかりませんか。モバイルテーマに挑戦してみましょう。あるいは、共有ボタンを移動させてみましょう)

次に、ベータテスト参加してはどうでしょう。ベータテスト参加者は、公開される前のアップデート、修正、新しいモジュールのテストを行います。これは、重要な開発プロセスの一部です。ベータグループへの参加に興味をお持ちの場合は、このフォームに記入してお知らせください。

Jetpack の機能の扱いに慣れたら、私たちがバグの追跡に使用する GitHubを使ってみましょう。バグレポートをすぐに提出していくことができます。

長距離飛行: 中級レベルのプログラマー

コードを読んだり編集したりが楽にできるのに自分で一からコードを書いたことがないのであれば、バグレポートを提出して、バグ駆除の支援をしてください。これまでにバグレポートを提出したことがないなら、優れたバグレポートを作成をご覧いただき、開発者が素早く効果的に問題を解決するために必要とするすべての情報がレポートに含まれているかを確認してください。

レポートを提出する場合は、GitHubにも慣れておく必要があります。レポート送信が楽にできるようになれば、コードを見ていき、次のステップに進む準備をしましょう。パッチの提出です。

銀河旅行: 上級レベルの開発者

自作のコードを書く方でしょうか。自分でプラグインを作ったことがあるかもしれません。あるいは、WordPress の核を直接見るために、サングラスをかけたことがあるかもしれません。他の人が書いたコードを読んで、改善点を提案することが楽にできるでしょうか。

そういった人なら、現場に飛び込み、パッチを作成し、提出してください。この既知の問題にアクセスし、注意を必要とするものとしてコミュニティーが特定している問題の形式についての知識を仕入れてください。

協力の基本

ベータグループへの参加

私たちのベータグループは、優秀な人たち (WordPress のユーザーおよび開発者からの選抜グループ) の集まりで、新しいバージョンの Jetpack について、間違っている (あるいは正しい) と教えてくれる人たちです。ベータテスターとしての役割は、Jetpack の新しいバージョンのテストの支援を行い、テストの結果を私たちに報告することです。UI がわかりにくいでしょうか。モジュールが正しく動作しないでしょうか。

協力に興味をお持ちの場合は、こちらのページからお知らせください。
参加するには、Jetpack βテスタープラグインをダウンロードしてインストールする必要があります。また、最新バージョンの WordPress を使用するようにしてください。(注: グループに参加するまでは、ベータテスタープラグインにアクセスすることはできません)

ソースコードのチェックアウト

WordPress を含むほとんどのソフトウェア・プロジェクトでは、ソースコードと改訂履歴を記録するため、バージョンコントロールシステムを利用しています。Jectpack は、GitHubで利用できます。これが、Git を利用して Jetpack をダウンロードする基本です。

(Git および GitHub になじみがない場合は、GitHub ガイドビデオから始めるのがいいでしょう)

Git のインストール

Git を入手する最も簡単な方法は、Git のウェブサイトからご使用の OS 向けのバイナリパッケージをダウンロードする方法です。Mac OSX 、Windows 、いくつかのバージョンの Linux など、ほとんどの主要な OS 向けのパッケージが存在します。

詳細については、Git のウェブサイトの資料をご覧ください。

GitHub アカウントの作成、SSH の鍵の作成

Jetpack のコードは、GitHub.comでホストされています。アカウントを作らなくても、プラグインのコードを閲覧することや、それをダウンロードすることさえできますが、バグレポートやパッチの提案により協力したい場合は、登録する必要があります。

登録の後に、SSH の鍵を作成し、ご使用のコンピューターと GitHub との間に安全な接続を確立しておくことをおすすめします。
これにより、毎回パスワードを入力しなくても、GitHub からコードを取得したりパッチを送信することが可能になります。
このガイドに従い、コンピューターとGitHubアカウントにSSHの鍵を追加してください。

Jetpack の Git レポジトリについて

ソースコードと改訂履歴は、レポジトリに保存されます。レポジトリには、コマンドラインインターフェイス (CLI) またはクライアントプログラムを使用することで接続できます。クライアントプログラムでは、ソースコードを確認、編集し、パッチを適用することができます。

Jetpack のレポジトリは、ここで利用できます。こちらは、以下の4つの重要なセクションから構成されています。

  • マスター: 最も最近に開発されたコードです。
  • リリース: どのバージョンの Jetpack を探しているかを教えてくれるコードです (例: 2.3.1) 。公開されているすべての Jetpack のバージョンには、タグが付けられています。
  • ブランチ: Jetpack の以前のリリースです。Jetpack の新しいメジャーリリースがあるときに、前のバージョンのバグ修正 (通常、主要なバグとセキュリティー問題に限られます) をしたものも公開し続けることがあります。
  • イシュー: バグ、機能リクエスト、コメント、提案、パッチ…。すべてが含まれます。

コードのチェックアウト

Git をインストールしたら、作業を始める前に、コードをチェックアウトする必要があります。リモート (レポジトリ) からコードをコンピューターにダウンロードします。やりかたは以下のとおりです。

  1. Jetpack の GitHub ページにアクセスし、「フォーク」ボタンをクリックします。
    Fork このとき、Jetpack の現在の開発バージョンを自分の GitHub アカウントにコピーします。
  2. コンピューター上でターミナルを開き、Jetpack を置きたい場所に移動します。
  3. クローンコマンドを実行します。たとえば、自分でGitHub上に作ったばかりの Jetpack レポジトリのコピーを確認するには、以下のようにします。
    git clone git@github.com:YOUR_GITHUB_USERNAME/ Jetpack .git  Jetpack
  4. Jetpack に移動します。ディレクトリ: cd Jetpack
  5. オリジナルの Jetpack のレポジトリを新しいリモートとして追加します。これにより、オリジナルのレポジトリに行った変更を取得し、ローカルのコピーを最新に保つことができるのです。
    git remote add upstream git@github.com:Automattic/ Jetpack .git

前回フォークを作成してからかなり経過している場合は、Jetpack の最新開発バージョンを使用しているかを確認した方がいいでしょう。コマンドをフェッチして統合を使用し、ローカルの変更を失うことなく、最新の Jetpack の変更をローカルレポジトリに適用します。

git fetch upstream

git checkout master

git merge upstream/master

良いバグレポートの書き方

イシュータブは、プロジェクトとバグを記録するために使用されるチケットデータベースです。私たちは、新機能、バグレポート、一般的なプロジェクト作業を管理するためにこれを使用します。これは、バグレポートやコードのパッチの提出ができるだけシンプルになるように設計されています。

GitHub のスターになるための3つのステップ

1. そのバグが本当にバグであるかを確認します

バグレポートを送信する前に、それが単なるインターネットの問題や互換性の問題でないことを確認してください。調査を始める前に、最新バージョンの WordPress と Jetpack を使用していることを確認してください。

他のプラグインをすべてオフにし、デフォルトの TwentyThirteen や TwentyFourteen のテーマに戻すことから始めます。まだ問題は継続していますか。まだ継続していれば、バグを発見したのかもしれません。

問題が消えた場合、ご使用のプラグインまたはテーマとの競合により問題が発生していたと考えられます。次に、1つずつテストしていきます。Jetpack とそのテーマまたはプラグインだけを有効化し、そのほかの変数を排除するのです。問題が再度発生すれば、犯人を発見できたことになります。

2. すでに報告されているかを確認します

バグがすでに報告されているかを確認するには、以下の方法があります。

このどこにも言及されていませんか。別のプラグインやテーマとの競合が原因ではありませんか。そうです。バグを発見したのです。レポートを送信するときです。

3. 詳細で正確なバグレポートを提出します

チケットが詳細であればあるほど、バグへの対処が容易になります。GitHub にログインし、新しいイシューを開き、関連する詳細すべてを記入します。簡潔な要旨と明確な説明が重要です。Jetpack サポートフォーラムなど、他の人が言及している場合は、リンクも記入してください。

役に立つ要旨のサンプルは以下のようなものです。

問題の要旨: 「 Jetpack Image 」ウィジェットに選択した画像が表示されない。

再現ステップ:

  1. 「 Extra Sidebar Widgets 」モジュールを有効化します
  2. サイドバーに「 Jetpack Image 」ウィジェットを表示し、画像URLを含め、フィールドを埋めます。
  3. ウィジェットを保存し、サイトを閲覧します

期待される動作または結果: サイドバーに選択した画像が表示される

実際の動作または結果: エラーが発生する。「画像が見つかりません」”

実例へのリンク (適用可能な場合) : http://example.com/image-widget/

スクリーンショット: エラーメッセージのスクリーンショットはこちらです

クロスブラウザチェック、別名「Internet Explorer 8を忘れないで」

バグを発見したと思い、上記のステップを踏んだら、別のブラウザでもその問題が再現されるかを確認する価値はあります。Browse Happyには、主要なブラウザの最新バージョンへのダウンロードリンクが用意されています。
その潜在的なバグが1種類のブラウザに限られたものかどうかも確認しなければなりません。これは、JavaScript または jQuery に関連する可能性があるバグの場合、特に重要です。こうした問題が発生しやすいブラウザが存在するためです。

既存の問題に協力したりコメントする

バグレポートとパッチの提出に加え、興味のあるあらゆる問題の進展をフォローしたり、既存の問題に詳細を追加することもできます。

問題をフォローするには、GitHub にログインし、興味のある問題を見つけ、最後までスクロールし、購読をクリックします:

Subscribe to an issue

既存のチケットに追加すべき情報を持っている場合は、自由にコメントしてください。

パッチの作成・提出方法

バグへの対処

バグを修正しているなら、Jetpack のレポジトリのフォークを作成するところから始め、Jetpack の新しいフォークをご使用のコンピューターに複製しましょう。それができたら、新しいブランチを作成します。そして、ブランチを調査します。

git branch branch-name

git checkout branch-name

その後、ファイルを編集し、変更をコミットします。

  • 変更したファイルのリストを取得するには、ステータスコマンドを使用します。
    git status
  • 行った変更を1行ごとにパッチフォーマットで表示するには、diffコマンドを使用し、ソースコードに行った変更の統一された diffを出力します。
    git diff
  • 1つのファイル中の異なる部分を表示するには、diff コマンドを使用します (あるいは、複数のページの異なる部分を表示するには、複数のファイルパスを入力します) 。
    git diff path/to/file

パッチのエクスポート

行った変更を共有するには、GitHub 上のレポジトリに変更を送信し、プルリクエストを送信する必要があります。

  1. ローカルレポジトリに行った変更をコミットするところから始めてください。そのためには、最初に、ステージングエリアに変更したファイルを追加する必要があります。
    git add .
  2. その後、変更をコミットします。
    git commit

    コミットメッセージの最初の行では、変更の簡単な説明を書き、簡潔にする方がいいでしょう。そして、その後の行で詳細について記述することができます。

  3. これで、変更をコミットできました。Github のフォークに送信する準備ができました。
    git push origin branch-name
  4. 最後のステップは、行った変更を私たちに知らせるためのプルリクエストの作成です。GitHubは、フォークにアクセスしたときに、このプルリクエストを作成するように促します。Create a Pull Request「比較とプルリクエスト」をクリックし、プルリクエストを作成します。

WordPress 開発のベストプラクティス

ベストプラクティスのため、WordPress.org codex の情報を参照してください。PHPHTMLCSSJavaScriptのコーディング標準についての詳細情報もご覧ください。

★見出し語の体言止めとかの形式をそろえよう。
★HTMLにして、読み直す。タグの入れ忘れもここで確認。

質問がある場合

この記事に関するコメントは締め切られていますが、私たちがいつでもお手伝いいたします。サポートフォーラムにアクセスしていただければ、ご質問にお答えいたします。

サポートフォーラムを表示
  • 協力者