Articles /

WordPress.org

WordPressの現在のインラインドキュメントの取り組みは、3.7のリリースサイクルから本当に始まり、hook docsイニシアチブが進むにつれて勢いを増しました。 Inline documentation、または”inline docs”イニシアチブはハイブリッドプロジェクトであり、CoreCore Coreに報告することはWordPressを実行するために必要なソフトウェアのセットです。 コア開発チームはWordPressを構築します。、ドキュメント、および開発者ハブチーム。

インラインドキュメントとは何ですか？ #インラインドキュメントとは何ですか？

インラインドキュメントは、WordPress自体のソースコード内のインラインコメント、docブロックなどの形で必要な情報と有用な情報の両方を提供します。

インラインドキュメントは各リリースで解析され、そのドキュメントは次のコードリファレンスに表示されますdeveloper.wordpress.orgWordPress.org WordPressのコードが作成され、ユーザーによって共有されるコミュニティサイト。 ここでは、WordPressのコア、プラグイン、テーマのソースコードと、コミュニティの会話や組織の中心的な場所をダウンロードできます。 https://wordpress.org/.

Top

how to get involved#How to get involved

インラインドキュメントは”技術的な”ドキュメントとみなされるため、WordPressのコードベースに精通している必要があります。

1. PHPドキュメントの標準、書式設定ガイドライン、文書化のヒントをよく理解してください。

2. Vagrant Vagrants（VVV）を使用して、WordPressコードベースの開発者バージョンのローカルコピーを設定します。 WordPressはSVNSVNを使用したバージョン管理ですApache Subversion（多くの場合、コマンド名svnの後にSVNと略記されます）は、ソフトウェアのバージョン管理とリビジョン管理シ ソフトウェア開発者は、ソースコード、webページ、ドキュメントなどのファイルの現在および履歴バージョンを維持するためにSubversionを使用します。 その目標は、広く使用されているConcurrent Versions System（CVS）のほとんど互換性のある後継者になることです。 WordPressのコアとwordpress.org リリースされたコードはすべてSVNを介して一元管理されます。 https://subversion.apache.org/. しかし、あなたはまた、GitGit Gitを使用することができますスピードと効率性と非常に大規模なプロジェクトに小さなからすべてを処理するように設計され Gitは習得が容易で、超高速のパフォーマンスを備えた小さなフットプリントを持っています。 最新のプラグインとテーマの開発は、このバージョン管理システムで行われています。 https://git-scm.com/. （それを行う方法のためのVVVリンク）。

3. Tracの作成方法については、チケットを開くをご覧くださいTracは、githubのように、バグや機能リクエストのために貢献者が課題を作成する場所です。https://core.trac.wordpress.org/. チケット…

4. パッチの作成:

  • ファイルを編集してパッチを作成する前に、常にWordPressトランクのローカルコピーを更新してください。 必要に応じてsvn upまたはgit pullを使用します。
  • WordPress SVNまたはGit checkoutのルートディレクトリからパッチを生成します。 たとえば、svn diff dir/filename.php > function_name.diffです。

5. パッチを送信する方法

インラインドキュメントの失敗を報告するパッチがあり、
たとえば、#48303はWordPress5.4のパッチです。

  • コメントを追加し、パッチファイルを添付します。

6. また、イテレーションを必要とするinline docs関連のTracチケットに貢献することもできます。

  • チケットがneeds-patchまたはneeds-refreshとマークされている場合、既存のパッチはタッチアップが必要か、最新のトランクに対して更新される可能性があります。 すべての小さなビットが役立ちます！

Top

Points of contact#Points of contact

質問については、Slackの#docsまたは#core-docsチャンネルでポップしてください。

Top

Resources#Resources

  • PHP Documentation Standard
  • Adam Brown’s Hooks Database(@sinceバージョンのHookshooksに関するヒントに役立ちますWordPressのテーマと開発では、フックはWordPressのアクションやフィルタに適用できる関数です。 アクションは、WordPressで特定のイベントが発生したときに実行される機能です。 フィルタを使用すると、特定の機能を変更できます。 フィルタとアクションの両方をフックするために使用される引数は同じように見えます。)

Top

新しいドキュメントチケットを開く方法#新しいドキュメントチケットを開く方法

基本的には、インラインドキュメントの失敗と改善を報告す ただし、何らかの理由で新しいチケットを作成する必要がある場合は、以下の手順に従います:

  1. Tracチケットを作成する方法については、「チケットを開く」をご覧ください。
  2. Core Tracでファイル用の新しいチケットを作成します。
    • 提案されたタイトル形式は、”PHPDoc correction for path/to/file.php”または”path/to/fileのドキュメントを改善します。php”。
    • 型は欠陥（バグ）でなければなりません。
    • ファイルが関連付けられているコンポーネントにチケットを割り当てます。
    • バージョンは空白のままにします。
    • それをクリックしてdocsフォーカスを追加します。
  3. 作成したtracチケットにパッチをアップロードし、キーワードhas-patchを追加します。
  4. 新しくアップロードされたパッチについて説明するコメントを残してください。 パッチをアップロードしても、チケットを見ている人には通知されません。

注:ドキュメントの変更は、チケットが特に両方を要求しない限り、コードの変更と混在させるべきではありません(空白文字でさえ)。

最終更新日：2019年10月26日

Leave a Reply