linkedin / linkedin/python-avro-json-serializer
Better doc
未关闭
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 135
- 派生
- 43
- PR 合并指标
- 30 天内没有已合并 PR
描述
Hi,
I'm a user of your library, it's great.
I had a couple of suggestion to improve the doc:
- add how to install w/ pip
- add imports statement to the examples
- add deserialize example
I can actually do it if you want.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先定位项目当前的文档和示例，然后检查目前对安装和序列化的描述方式。更新文档，加入使用 pip 的安装说明、示例中的 imports 以及一个 deserialize 示例；当三个请求都得到覆盖且示例仍然易于理解时，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 半天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100