Improve Endpoint Documentation
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 領域
- api, documentation
調査の方向性
https://api.leighhack.org/docs のリンク先にある API ドキュメントから始め、FastAPI のエンドポイント定義を調べて、現在何がドキュメント化されているかを確認します。各エンドポイントの目的が説明されるようにエンドポイントのドキュメントを拡張し、その後、公開されたドキュメントですべてのエンドポイントが網羅されていることを確認します。
索引モデルが issue の本文から書いたものです。
説明
Documentation is available at https://api.leighhack.org/docs but only has the basics. We need to extend them out to describe what each endpoint does.
- 主要言語
- Python
- スター
- 0
- フォーク
- 0
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
leigh-hackspace/hackspace-api のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
Dependency Dashboardオープン
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
leigh-hackspace/hackspace-api の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜2日 初心者へのやさしさ 70/100
-
FingerprintSplitter raises ZeroDivisionError when int(frac_train * len(dataset)) floors to zeroオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 7 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
lmstudio-ai/mlx-engine#376 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
pyiron/bagofholding#166 ·