[DOCS] showcases, examples & general docs improvements
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず既存の examples/ ディレクトリと docs/examples.rst を確認し、次にそれらが README と API ドキュメントからどのようにリンクされているかを確認します。列挙された目標はすべてチェックされるため、最初に残っている例またはドキュメントの不足を特定してください。複雑な使用方法の有用な例をドキュメント化し、関連するリンクと CI の期待事項を正しく維持できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
📣 THIS IS A CALL FOR DOCS
Feel free to add pull requests with examples here:
- https://github.com/CycloneDX/cyclonedx-python-lib/tree/main/examples
- https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/docs/examples.rst
There are currently no (complex) examples how to use this lib.
Yes, there are API docs, and small snippets, but no examples.
Even the unit tests do now showcase example usage, as they are much declarative or not expressive enough.
GOAL:
- have examples in a
examplesfolder - link the examples in the README
- link the examples in the (api)-docs
- prevent
examplesdir from being shipped (sdist/bdist) - have examples run in CI
- 主要言語
- Python
- スター
- 117
- フォーク
- 67
- 平均マージ
- 21時間 9分
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
CycloneDX/cyclonedx-python-lib のほかの issue
-
[PERF] Quadratic (O(N^2)) serialization time for large BOMs — `Bom.validate()` → `register_dependency()` linear scan対応中かも @inspired-geek が 109 日前に担当しました。 オープンperformance
難易度 3/5 1〜2日 初心者へのやさしさ 36/100
CycloneDX/cyclonedx-python-lib#1006 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
tests: test all model enums再び着手できるかも @jkowalleck が 124 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンQA
CycloneDX/cyclonedx-python-lib#991 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
feat(deps)!: make all de/serialization libraries optional再び着手できるかも @Simoh23999 が 72 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンbreaking change dependencies
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
CycloneDX/cyclonedx-python-lib#979 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
feat: Add support for Component signature対応中かも @wiebe-vandendriessche が 123 日前に担当しました。 オープンenhancement help wanted schema 1.4
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
CycloneDX/cyclonedx-python-lib#978 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
chore: have coverage uploaded consitently再び着手できるかも @jkowalleck が 171 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンchore
CycloneDX/cyclonedx-python-lib#966 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
CycloneDX/cyclonedx-python-lib の issue をすべて見る
似ている issue
-
area: desktop area: website priority: P2 type: feature
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
appandflow/stim#3411 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1時間未満 初心者へのやさしさ 88/100
baptistehamon/lsapy#185 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
PolicyEngine/policyengine-us#10073 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
syedhamidali/radarx#277 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Arekkazu/sgpmp-backend#549 ·
メンテナーはふだん 1 日以内に返信