[DOCS] showcases, examples & general docs improvements
维护者通常 1 天内回复
还没有人认领这个 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
- 平均合并
- 21 小时 9 分钟
- 30 天内合并 PR
- 3
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 于 125 天前认领，目前没有进行中的 PR。 未关闭QA
CycloneDX/cyclonedx-python-lib#991 · 已指派 1 人 ·
维护者通常 1 天内回复
-
feat(deps)!: make all de/serialization libraries optional可能重新可做 @Simoh23999 于 73 天前认领，目前没有进行中的 PR。 未关闭breaking change dependencies
难度 5/5 一周以上 新手友好度 35/100
CycloneDX/cyclonedx-python-lib#979 · 2 条评论 ·
维护者通常 1 天内回复
-
feat: Add support for Component signature可能已有人在做 @wiebe-vandendriessche 于 124 天前认领。 未关闭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 天前认领，目前没有进行中的 PR。 未关闭chore
CycloneDX/cyclonedx-python-lib#966 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 CycloneDX/cyclonedx-python-lib 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 83/100
PedestrianDynamics/pyFDS-Evac#766 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 91/100
alchaincyf/nuwa-skill#86 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 2 天内回复
-
Docs Needs Triage
难度 1/5 1 小时以内 新手友好度 88/100
pandas-dev/pandas#71055 ·
维护者通常 1 天内回复
-
[Bug]: graphify reads files that git's global ignore file hides可能已有人在做 @smngvlkz 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
Graphify-Labs/graphify#4335 · 1 条评论 ·
维护者通常 1 天内回复