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

Autogenerate JSON Schema and Documentation

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
php, typescript

調査の方向性

まず、packages/playground/blueprints/bin/generate-schema.js にある TypeScript ジェネレーターと、issue にリンクされているチェックイン済みの public/blueprint-schema.json を比較し、その後 PHP blueprint のソースと step 引数の定義を調べます。生成を実装する前に、PHP 引数をどのように表現すべきかを定義します。PHP スキーマとドキュメントがコードから生成され、常に最新の状態に保たれれば完了です。

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

説明

Architecture documentation

Typescript Blueprints shipped a JSON Schema and documentation generated from the TypeScript source:

https://github.com/WordPress/wordpress-playground/blob/ef1eb3f57ee251ec98f6075ff7e83d22add188e0/packages/playground/blueprints/public/blueprint-schema.json

The PHP version could do the same to ensure the schema and the documentation are always up to date with the code. This may require taking specific design choices, such as shipping steps arguments as classes:

class WriteFileStepArgs implements StepArgs {
	public $file;
	public string $toPath;

	/**
	 * @param $file
	 * @param string $toPath
	 */
	public function __construct( $file, string $toPath ) {
		$this->file   = $file;
		$this->toPath = $toPath;
	}

}
主要言語
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 を短くまとめたダイジェスト。