Improve `gen-schema-doc` script dev experience

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

メンテナーはふだん 1 日以内に返信

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
javascript, python
領域
tooling

調査の方向性

まず、json-schema-for-humans をインストールしていない状態で gen-schema-doc スクリプトを実行し、基盤となるエントリーポイント doc-schema.js と現在のエラーを調査します。不足している Python 依存関係が文書化されるか、スクリプトが不可解なエラーではなく、必要な要件を説明的に報告すれば作業は完了です。

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

説明

enhancement tech-debt

Right now, executing the gen-schema-doc script without setting things up correctly, results in a cryptic error that doesn't tell you that the Python library json-schema-for-humans is needed to run the underlying doc-schema.js script.

Simply executing pip install json-schema-for-humans beforehand fixes this (assuming pip is available). We should either document this somewhere, or make sure that the doc-schema.js script gives a more descriptive error when failing.

主要言語
TypeScript
スター
263
フォーク
185
平均マージ
2日 15時間
マージ済み PR(30日)
39

環境構築

はじめの一歩

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

finos/git-proxy のほかの issue

finos/git-proxy の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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