私がWordPress.orgに最初に付けたプラグインは9 日間何も出荷しませんでした コードをコミットし、リリースにタグを付け、新しい説明でリストの更新を見て、人々にそれが出たことを伝えました ダウンロードボタンは空のタグフォルダを提供していたため、ダウンロードは横ばいでした: 私の readme.txt 言った Stable tag: 1.0.1 そして実際に作ったタグは 1.0.何も警告しなかった.ディレクトリは,私が言ったことを正確に実行した.
この行は、WordPress プラグイン & #39;s の最高賭け金フィールドです readme.txt、そしてそれは大声でではなく静かに失敗するいくつかのうちの1 つです このガイドは、損傷が発生する傾向がある順序で、ディレクトリがそのファイルの各部分で何を行うかをカバーしています WordPress Readme Generator これらのルールが適用されるフィールドに添付されたファイルを構築します。
tl;dr:
Stable tagディレクトリが実際に提供するバージョンに名前を付けます。 から読み取られますtrunk/readme.txt、そして下のフォルダーを指します/tags/それは存在する必要があり、リリースを含む必要があります。そこにないバージョンに名前を付けると、ユーザーは何も得られません。古いものに名前を付けたままの場合、コミットした内容に関係なく、古いコードを取得します。Tested up toあなたのリスティングの互換性の警告を制御します、Tags最初の 5 文字のみにインデックスを付け、短い説明は 150 文字にカットされます。
Stableタグは実際に何を制御しているのでしょうか?
ディレクトリ内のプラグインは Subversion に存在します trunk/ 現在の開発のため、および tags/<version>/ リリースの場合 誰かがダウンロードをクリックすると、ディレクトリはそれらを送信しません trunk。 と読める trunk/readme.txt、 見つける Stable tag、 と 務める tags/<that value>/。
3 つの結果が続き、3 つすべてが実際のリリースを噛みます:
- これを判断するreadmeがトランク内のreadmeです。 タグ フォルダー内で readme を編集しても、出荷内容については何も変更されません。
- タグは存在する必要があります。 あ
Stable tag作成されなかったフォルダーに名前を付けると、ダウンロードが空であるか失敗することを意味します。 - トランクはユーザーが受け取るものではありません。 あなたは一週間中トランクにコミットすることができます;安定したタグが移動するまで、リリースされたコードは古いタグが保持しているものであれば何でも構いません。
ザ・ プラグイン ハンドブック は規則を明確に述べており、別のプラグインから readme をコピーしてフィールドを編集するよりも、一度きちんと読む価値がある。 1つ知っておく価値のある例外: Stable tag: trunk "serve trunk" を意味します。これは合法であり、少数のプラグインがリリースする方法です。また、trunk へのすべてのコミットがすべてのユーザーに対してすぐに有効になることも意味するため、ほとんど誰も実行すべきではありません。
リリースまでには、readmeがまったく制御しない後半があります。 でのバージョン Stable tag に合わせなければなりません Version: メインのプラグイン PHP ファイル内のヘッダー。これは、インストールされているサイトが更新プログラムが存在するかどうかを判断するために比較するものであるためです。プラグイン ヘッダーに前の番号が記載されているタグを出荷すると、ディレクトリには、すでに存在するバージョンであると主張する何かをインストールする更新プログラムが提供されます。
各ヘッダー行がリスティングに与える影響
ヘッダー ブロックは 9 行のプレーンです Key: value そして、それらはすべて目に見えるものを変えます。
| 線 | それが何をするか | 何がうまくいかないのか |
|---|---|---|
Stable tag |
提供されたバージョンを選択します | 間違った価値は何も出荷しないか、古いコードを出荷します |
Requires at least |
最低 WordPress バージョン | 高すぎるブロックが動作するようにインストールします |
Tested up to |
互換性に関する声明 | 遅れると "untested" が表示されます。警告 |
Requires PHP |
最低 PHP バージョン | 低すぎると、互換性のないサイトがインストールされて失敗します |
Tags |
ディレクトリキーワード | 最初の 5 つだけがインデックス付けされています |
Contributors |
リンク WordPress.org プロフィール | 入力ミスには誰もクレジットされません |
Donate link |
サイドバー 寄付 ボタン | 不在でもいいし、壊れてもダメだ |
License / License URI |
ライセンス | リストするには GPL 互換である必要があります |
Tested up to は、サイレントにダウンロードのコストです.それは後ろにいくつかのコアリリース以上落ちるとき, リストは、訪問者にプラグインがテストされていないことを伝える通知を示しています WordPress の彼らのバージョン, 放棄されたように見えるプラグインは、それが動作するかどうかに関係なく、インストールされる量が少なくなります.その行を更新することは、トランクにreadmeコミットと分かかります, これは、エコシステムで最も安価なメンテナンスです。
Tags 5 つにインデックスを付けます。 6 番目のタグはエラーではなく、警告も生成されません。ファイル内の単なる死文です。実際に入力する 5 人を選択します。
説明はどのように分割されますか?また、なぜ分割されるのでしょうか?
readme には 2 つの説明があり、それらは異なる仕事をします。
ザ・ 短い記述 ヘッダー行と最初の行の間のテキストの単一ブロックです == Section ==。 150 文字で上限があり、ディレクトリが検索結果やプラグイン カード上で、通常は文の途中でそれを切り捨てます。これは、ほとんどの人がクリックするかどうかを決定する前に読む行であり、150 文字がファイル内で最も価値のある不動産になります。
ザ・ 長い記述 か == Description == セクションとそれはあなたのリストページの本体になります。 markdownのサブセットを取ります:見出し、太字、斜体、リスト、リンク。 生のhtmlは剥ぎ取られます。 テーブル、構文強調表示付きの柵で囲まれたコードブロック、およびよりエキゾチックなmarkdownはレンダリングされないため、markdownプレビューアで正しく見えるreadmeは、wordpress.orgでは依然として間違って見える可能性があります。
他のセクションは、それぞれリストのタブにマップします:
== Description == the main body
== Installation == the Installation tab
== Frequently Asked Questions == the FAQ tab, one "= question =" per entry
== Screenshots == numbered captions, matched to files in /assets/
== Changelog == one "= version =" block per release, newest first
== Upgrade Notice == the short line shown inside wp-admin on update
Upgrade Notice 通常よりも注目に値します。これは、ほとんどのユーザーが更新をクリックする前に表示する唯一のテキストです。更新プロンプトで、このリリースが重要な理由を説明する 1 行または 2 行。セキュリティ修正、変更の断絶、新しい PHP 要件。空のままにしておくと、更新は単なる数字です。
バナーとアイコンはどこに住んでいますか?
に ない readme.txt。readme はリスト コンテンツの 1 つおきがどこから来るのかということで、これは初めてほぼすべての人を魅了します。
画像は生きています /assets/ SVN のディレクトリ、横 trunk あんど tags、そしてそれらはファイル名によって一致します:
| ファイル | 目的 | サイズ |
|---|---|---|
banner-772x250.png |
リスティングヘッダー | 772 x 250 |
banner-1544x500.png |
Retinaヘッダー | 1544 x 500 |
icon-128x128.png |
検索結果アイコン | 128 x 128 |
icon-256x256.png |
Retina アイコン | 256 x 256 |
screenshot-1.png |
最初のスクリーンショット | どれでも |
スクリーンショットは番号で読み取り値に戻ります。 screenshot-1.png の下の最初の行で説明されています == Screenshots ==、 screenshot-2.png 2 つ目までに、というようにします。 matching file がないキャプションは何も表示されません; caption がないファイルは、ラベル付けされていない画像を表示します。
良い変更履歴はどのように見えますか?
リリースごとに1 ブロック、一番上に最新、各行はユーザーから何が変わったかを示しています& #39; sの観点:
= 3.2.5 =
* Fixed: admin menu order lost after a role change
* Improved: login customizer previews without saving
= 3.2.4 =
* Added: per-role dashboard widget visibility
" バグの修正と改善"変更ログでは、ユーザーに何も伝えず、レビュー担当者にもあまり伝えません。変更ログでは、プラグインを信頼するかどうかを決定する人が最初に表示される場所でもあります。特定のエントリの安定したリストはメンテナンスとして読み取られ、2 年間のギャップは、コードがまだ機能するかどうかにかかわらず放棄として読み取られます。
長いチェンジログはトリミングしても問題ありません。最近のリリースはそのままにしておきます readme.txt そして残りをaに移動します changelog.txt;ディレクトリはトリミングされたディレクトリを読み取り、履歴はリポジトリに残ります。
出荷する前にファイルを確認してください
機械的なチェックは迅速です Stable tag 存在するタグ フォルダーと一致します。一致しますか Version: プラグインヘッダーでは、 は Tested up to 現在の は 150 文字未満の短い説明ですが、タグは 5 つ以下ですか。
WordPress.org には、 公式 readme バリデータ これはファイルを解析し、読み込めなかったものを報告するもので、リリースごとに 1 回実行する価値があります。 ザ Readme Generator 別の方向に進みます。フィールドからファイルをビルドし、適用されるフィールドの横にこれらの各制限を記述し、ファイルが作成するリストをプレビューし、既存のファイルを読み取ります readme.txt フォームに戻ると、古いプラグイン' s ファイルを再入力せずに最新の状態にすることができます。
他の人& #39; を見ている場合自分のものを公開するのではなく、sプラグイン、 WordPress プラグイン 検出器 ページが読み込む内容と、 テーマ検出器 その背後にあるテーマを読みます。
