Autogenerate JSON Schema and Documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- php, typescript
- 領域
- documentation, tooling
調査の方向性
まず、packages/playground/blueprints/bin/generate-schema.js にある TypeScript ジェネレーターと、issue にリンクされているチェックイン済みの public/blueprint-schema.json を比較し、その後 PHP blueprint のソースと step 引数の定義を調べます。生成を実装する前に、PHP 引数をどのように表現すべきかを定義します。PHP スキーマとドキュメントがコードから生成され、常に最新の状態に保たれれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Typescript Blueprints shipped a JSON Schema and documentation generated from the TypeScript source:
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
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
WordPress/php-toolkit のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
WordPress/php-toolkit#313 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 58/100
WordPress/php-toolkit#306 ·
-
WPCS complianceオープン
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
WordPress/php-toolkit#157 · リアクション 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
WordPress/php-toolkit#138 · コメント 7 件 · リアクション 2 件 ·
-
[Blueprints v2] Constraint the Blueprint bundle format対応中かも @JanJakes が 439 日前に担当しました。 オープンBlueprints enhancement
WordPress/php-toolkit#132 · コメント 4 件 · 担当者 1 名 ·
WordPress/php-toolkit の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 60/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
scanaislop/aislop#476 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
components-web-app/api-components-bundle#403 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
mollie/PrestaShop#1566 ·
メンテナーはふだん 1 日以内に返信