Code a tool to update a JSON reference file
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- documentation, tooling
調査の方向性
まず、repository のドキュメント生成フローを読み、JSON リファレンスがどこで生成されるかを特定します。コード例、チュートリアルへのリンク、リファレンスなどの追加フィールドをどのように提供し、保持すべきかを確認し、そのうえでソースコードを煩雑にせずに生成済みリファレンスを更新するための受け入れ基準を定義します。
索引モデルが issue の本文から書いたものです。
説明
To make the docs maker as flexible as possible, we'd like to support having JSON keys or metadata on top of the one generated by the tool. That is to say, extra fields that may not be in the tool, like code examples, links to tutorials, references... extra information that would clutter the source code.
- 主要言語
- Python
- スター
- 297
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
GDQuest/gdscript-docs-maker のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
GDQuest/gdscript-docs-maker#95 · コメント 4 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
GDQuest/gdscript-docs-maker#86 · リアクション 1 件 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
GDQuest/gdscript-docs-maker#71 · コメント 3 件 ·
GDQuest/gdscript-docs-maker の issue をすべて見る
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
instance instance add
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
searxng/searx-instances#939 · コメント 1 件 ·
-
area-deployment area-integrations triage:bot-seen
難易度 2/5 半日 初心者へのやさしさ 86/100