Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Better doc

未关闭
#9 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
半天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

首先定位项目当前的文档和示例,然后检查目前对安装和序列化的描述方式。更新文档,加入使用 pip 的安装说明、示例中的 imports 以及一个 deserialize 示例;当三个请求都得到覆盖且示例仍然易于理解时,即视为完成。

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

描述

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.

主要语言
Python
星标
135
派生
43
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

linkedin/python-avro-json-serializer 的其他 Issue

查看 linkedin/python-avro-json-serializer 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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