cloudevents / cloudevents/sdk-python
Improve in-code documentation
未关闭
还没有人认领这个 Issue。
enhancement
- 主要语言
- Python
- 星标
- 342
- 派生
- 65
- PR 合并指标
- 30 天内没有已合并 PR
描述
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先调查 Python 代码库，查找缺失的 pydocs，并审查 issue 中提到的提议 PRs。范围涵盖几乎所有代码中的文档和示例，以及一项用于防止 PRs 缺少文档的政策。要完成这项工作，需要达成一致的方法，并广泛覆盖缺失的文档。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100