CycloneDX / CycloneDX/cyclonedx-python-lib

[DOCS] showcases, examples & general docs improvements

未关闭
#396 5 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation help wanted
主要语言
Python
星标
116
派生
67
平均合并
8 天 2 小时
30 天内合并 PR
2

描述

:mega: 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:
- [x] have examples in a `examples` folder
- [x] link the examples in the README
- [x] link the examples in the (api)-docs
- [x] prevent `examples` dir from being shipped (sdist/bdist)
- [x] have examples run in CI

----

贡献指南

打开贡献指南

调研方向

首先检查现有的 examples/ 目录和 docs/examples.rst,然后查看它们是如何从 README 和 API 文档链接的。由于列出的每个目标都会经过检查,请先确定示例或文档中仍存在的缺口;完成的标准是记录一个有用的复杂用法示例,并确保相关链接和 CI 预期保持正确。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。