Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Using multiple blueprint files (partials)

オープン
#97 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
php
領域
tooling

調査の方向性

まず、issue で説明されている blueprint parser と既存の WPCLIStep 処理、および WXR ファイルに使用されている assets ディレクトリの場所を確認します。部分的な blueprint ファイルをどのように連結するか、提案された ImportWXR step がどのように動作するかを定義し、その後、文書化されている plugin 開発の手順に照らして設計を検証します。

索引モデルが issue の本文から書いたものです。

説明

documentation enhancement

The blueprint.json files offer tremendous opportunity from a scaffolding and programmatic standpoint to developers using WordPress Playground. What if it were possible to chain together multiple blueprints to create an instance?

Use case: Build Playground docs for WordPress Plugin development

I want to see all documentation tagged plugin developer

User goes to documentation, searches "develop plugins with Playground" and finds a list of all the documentation that is tagged with plugin developer.

Docs: Creating a Plugin with WordPress Playground (post_title)
Steps: (post_content) - see below - raw .json
Description: Importing multiple WXR files to build a catalog of posts (post_excerpt)

Pseudocode
  • InstallTheme schoolyard
  • LoginStep
  • ImportWXR getting-started-with-plugin-development-in-playground.wxr
  • ImportWXR understanding-plugin-headers.wxr
  • ImportWXR plugin-activation-hooks.wxr
  • ImportWXR plugin-deactivation-hooks.wxr
  • ImportWXR plugin-uninstall-hooks.wxr
  • ImportWXR plugin-security-best-practices.wxr
  • ImportWXR plugin-translation-best-practices.wxr
  • ImportWXR plugin-licensing-best-practices.wxr
  • InstallPluginStep create-plugin
  • InstallPluginStep plugin-review-check.zip
  • InstallPluginStep plugin-security-check.zip
  • ActivatePluginStep create-plugin
  • ActivatePluginStep plugin-review-check
  • ActivatePluginStep plugin-security-check
  • ImportWXR submit-plugin-for-review.wxr
  • LandingPage /

Now the user will come to the Schoolyard theme, and see the documentation for creating a plugin with WordPress Playground, with Step by Step instructions for building a WordPress Plugin.

Limitations

ImportXWR isn't implemented

Currently ImportWXR does not exist as a step in the blueprint.json file. This step could be implemented simply with a WPCLIStep and import command, and link to a WXR file in the assets directory.

Blueprint parser extended

New functionality would have to be created to chain blueprint.json files.

Creating this Step would open the door to building out documentation based on user needs in lieu of having a bunch of extra docs. For example, a new user to WordPress does not need to understand how to run Playground through a web socket.

Conclusion

Being able to chain blueprints together would open up the ability to add "partial" blueprints, which could be used modularly to build out a Playground instance.

主要言語
PHP
スター
62
フォーク
23
平均マージ
4時間 12分
マージ済み PR(30日)
1

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

WordPress/php-toolkit のほかの issue

WordPress/php-toolkit の issue をすべて見る

似ている issue

PHP の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。