[DOCS] showcases, examples & general docs improvements
還沒有人認領這個 Issue。
評估
- 難度
- 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
- 平均合併
- 3 天 9 小時
- 30 天內合併 PR
- 4
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
CycloneDX/cyclonedx-python-lib 的其他 Issue
-
Support Python 3.15可能已有人在做 @jkowalleck 於 3 天前認領。 未關閉enhancement
CycloneDX/cyclonedx-python-lib#1056 · 已指派 1 人 ·
-
[PERF] Quadratic (O(N^2)) serialization time for large BOMs — `Bom.validate()` → `register_dependency()` linear scan可能已有人在做 @inspired-geek 於 124 天前認領。 未關閉performance
難度 3/5 1-2 天 新手友好度 36/100
CycloneDX/cyclonedx-python-lib#1006 · 2 則留言 ·
-
tests: test all model enums可能重新可做 @jkowalleck 於 139 天前認領，目前沒有進行中的 PR。 未關閉QA
CycloneDX/cyclonedx-python-lib#991 · 已指派 1 人 ·
-
feat(deps)!: make all de/serialization libraries optional可能重新可做 @Simoh23999 於 87 天前認領，目前沒有進行中的 PR。 未關閉breaking change dependencies
難度 5/5 一週以上 新手友好度 35/100
CycloneDX/cyclonedx-python-lib#979 · 2 則留言 ·
-
feat: Add support for Component signature可能已有人在做 @wiebe-vandendriessche 於 138 天前認領。 未關閉enhancement help wanted schema 1.4
難度 3/5 1-2 天 新手友好度 58/100
CycloneDX/cyclonedx-python-lib#978 · 4 則留言 ·
查看 CycloneDX/cyclonedx-python-lib 的全部 Issue
相似的 Issue
-
The changelog workflow excludes otelbot but not dependabot, so every Dependabot pull request fails the changelog check可能已有人在做 @ocelotl 今天認領。 未關閉
難度 1/5 1 小時以內 新手友好度 82/100
open-telemetry/opentelemetry-python#5825 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
cuga-project/cuga-agent#1020 ·
維護者通常 2 天內回覆
-
難度 1/5 1 小時以內 新手友好度 70/100
microsoft/playwright#43640 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 84/100
stac-utils/stac-fastapi-elasticsearch-opensearch#965 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 70/100
維護者通常 1 天內回覆