doc: consider re-adding a "quickstart" document
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
examples/ 配下のクライアントおよびリポジトリの例を確認し、QUICKSTART.md が #1790 によって削除された後、それらが README.md と docs/index.rst からどのようにリンクされているかを追跡します。既存の資料を、要求されている quick-start の目標および CII badge の基準と比較します。ドキュメントの方針と、必要な位置付けまたは追加内容が明確に定義され、実装されれば作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
Supersedes https://github.com/theupdateframework/python-tuf/issues/1006
Description of issue or feature request:
#1790 removes QUICKSTART.md because it is severely outdated. The new client and repo examples should be a good replacement to quickly get users familiar with python-tuf and are also easy to discover (e.g. via main README and main menu on RTD).
Still, there might be merit in better framing these examples or adding additional examples as a "quick start"-documentation (note: this is also a silver criteria for the cii badgeapp).
Current behavior:
- no explicit "quick start" documentation
Expected behavior:
- consider adding quick start documentation or better frame existing documentation
- 主要言語
- Python
- スター
- 1.7k
- フォーク
- 304
- 平均マージ
- 1日 2時間
- マージ済み PR（30日）
- 17
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
theupdateframework/python-tuf のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
theupdateframework/python-tuf#3001 ·
メンテナーはふだん 2 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
theupdateframework/python-tuf#2979 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
enhancement github_actions
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
theupdateframework/python-tuf#2920 · コメント 1 件 · リアクション 2 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
theupdateframework/python-tuf#2842 · コメント 3 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
theupdateframework/python-tuf#2836 · コメント 7 件 ·
メンテナーはふだん 2 日以内に返信
theupdateframework/python-tuf の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
gradio-app/gradio#13895 ·
メンテナーはふだん 1 日以内に返信
-
build-error
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
spack/spack-packages#6713 ·
メンテナーはふだん 1 日以内に返信
-
Use issue templates オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ActivityWatch/activitywatch#1464 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: The ckg tool drops the return type of every decorated Python method in class search results オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
bytedance/trae-agent#483 ·
メンテナーはふだん 1 日以内に返信