プラグインの計画、申請、メンテナンス

次の Hello Dolly をを書き上げ、世界中の人に使ってもらいたいと考えています。どうすればいいですか ?

1. テスト、もう一度テスト

運が良ければ、あなたのプラグインは、さまざまな状況やホスティング環境で多くの人に使われるでしょう。プラグインがどのような状況でも動作し、ユーザーをイライラさせないことを確認するために、プラグインのテストを行うことをおすすめします。

2. 良い名前の選択

プラグインの名前は、あなたとあなたの作品の独自性を反映したものでなければなりません。名前を選択する際、商標を侵害したり、他人の製品名を踏みにじったりしていないことを確認してください。もしあなたが FaceRange (架空の会社) の下で働いていないなら、あなたのプラグインに「FaceRange’s Dancing Squirrels」という名前を付けるべきではありません。たとえば、「Dancing Squirrels for FaceRange」の方がずっと良い名前でしょう。良い名前を思い付くのは難しいかもしれませんから、時間をかけてください。プラグインの URL は申請後に変更できませんが、表示名は何千回でも変更できます。

表示名は、メイン・プラグインファイルのヘッダーから生成されるので、書き間違いのない様に、注意してください。

3. 適切なドキュメントの作成

ファイル README.txt は、すべてのプラグインの標準的な参照ポイントであるため、開始するのに最適な場所です。以下を必ず含めてください:

  • あなたのプラグインが、実際に何をするのかを簡潔に説明しましょう。たくさんのことをするのであれば、プラグインを2つにしたほうがいいかもしれません。
  • 特に特別な設定が必要な場合、インストールに関して説明しましょう。ユーザーがあなたのサービスに登録する必要がある場合は、必ずそのリンクを張ってください。
  • サポートの受け方と、何をサポートし、何をサポートしないか、の指示を説明しましょう。

4. プラグインの申請

プラグインを申請するには、3つのステップがあります:

  1. WordPress.org に、有効で定期的にチェックされるメールアドレスで登録します。会社を代表してプラグインを提出する場合は、確認のために 公式な 会社の電子メールを使用してください。
  2. メールクライアントで plugins@wordpress.org をホワイトリストに登録し、確実にメールを受信できるようにしましょう。
  3. プラグインが何を行うかの簡単な概要と、完全な、すぐに使える、プラグインの zip ファイルを添えてプラグインを申請します。zip は、プラグイン・インストーラから手動でアップロードするのと同じように、プラグインの完全なバージョンでなければなりません。

プラグインがレビューのためにキューに入ったら、14営業日以内に問題がないかコードをレビューします。ほとんどの問題は、ガイドラインに従うことで回避できます。問題が見つかった場合は、開発者に連絡し、解決に向けて努力します。承認されると、プラグインを格納する Subversion リポジトリへのアクセス方法の詳細が記載されたメールが届きます。

Subversion (SVN) 経由で、そのリポジトリにプラグイン (とファイル readme) をアップロードすると、プラグイン・ディレクトリに表示されます。

5. 最初のバージョンの投入

WordPress.org のプラグイン・ディレクトリは、潜在的なユーザーがあなたのプラグインをダウンロードしてインストールする最も簡単な方法です。WordPress とプラグイン・ディレクトリの統合は、ユーザーが数回クリックするだけでプラグインを更新できることを意味します。

最初のバージョンをリリースする準備ができたら、サインアップしたいと思うでしょう。レビュープロセスが正常に完了すると、コード用の Subversion リポジトリが与えられます。WordPress.org で SVN の使用に関するドキュメントがありますが、Git を使用する場合に慣れているワークフローとは少し異なります。

6. オープンソースの採用

オープンソースは、国境を越えたコラボレーションを可能にする、現代で最もパワフルなアイデアのひとつです。貢献を奨励することで、他の人々があなたと同じように、あなたのコードを愛せます。あなたのコードをオープンソース化するには、いくつかの選択肢があります:

  • Github は、あなたのプロジェクトに他の人を参加させることを簡単にします。他の開発者やユーザーは、バグフィックスやレポート、機能リクエスト、あるいは真新しい貢献を簡単に提出できます。GitHub には、素晴らしいドキュメントポータルがあります。
    • Bitbucket と Gitlab は、似たような機能を持つ代替手段です。
  • WordPress.org プラグイン・ディレクトリは、Subversion リポジトリを提供し、使用することを要求します。

7. ユーザーの声に耳を傾ける

あなたが想像していた以上に、ユーザーがあなたのコードに多くのテストケースを課していることに気付くでしょう。これは、途轍もなく貴重なフィードバックになります。

WordPress.org を通じてコードを公開するということは、あなたのプラグインが自動的にサポートフォーラムを持つことを意味します。それを使いましょう ! 新しい投稿をメールで受け取り、ユーザーにタイムリーに対応できます。彼らは、あなたと同じように、あなたのプラグインを愛したいと思っています。

Jetpack には、優れたバグレポートの書き方についての投稿があります。

8. 定期的な新バージョンの投入

最高のプラグインとは、時間をかけて小さな変更を繰り返し続けるものです。アップデートを長く延期しすぎて、苦労して作ったプラグインを時代遅れにさせないでください。一方、絶え間ないアップグレードは「アップデート疲れ」を引き起こし、ユーザーはアップグレードをやめてしまうということも、心にとどめておいてください。少なすぎるアップデートと多すぎるアップデートのバランスを保つことが重要です。

9. 同じ手順の繰り返し

人生の他の部分と同じように、最高のものは忍耐と努力から生み出されるものなのです。

原文 / 日本語訳

s
検索
c
新規投稿を作成する
r
返信
e
編集
t
ページのトップへ
j
次の投稿やコメントに移動
k
前の投稿やコメントに移動
o
コメントの表示を切替
esc
投稿やコメントの編集をキャンセル