跳转至

Good First Issues

欢迎新贡献者！这里列出了一些适合初次贡献的任务，难度较低且有明确的实现指引。选择一个你感兴趣的任务开始吧。

🟢 Easy

1. 补充文档中的代码示例

描述：为 API 参考文档中的图表类补充更多的使用示例，帮助开发者更好地理解如何使用各种配置选项。

涉及文件： - docs/api-reference.md

预计工作量：2-3 小时

实现指引： 1. 选择一个图表类（如 Line、Bar、Pie 等） 2. 编写 2-3 个不同场景的使用示例 3. 示例应包含：基础用法、高级配置、常见场景 4. 确保代码示例可以直接运行 5. 在 API 参考文档中添加这些示例

2. 改善错误提示信息

描述：当用户传入错误的参数时，改善错误提示信息，使其更加清晰易懂，帮助用户快速定位问题。

涉及文件： - pyantv/charts/base.py - pyantv/charts/chart.py - pyantv/options/ 下的相关文件

预计工作量：3-4 小时

实现指引： 1. 查找现有的错误提示信息 2. 识别哪些错误提示不够清晰 3. 改进错误提示，添加具体的错误原因和建议的修复方法 4. 添加单元测试验证新的错误提示 5. 确保错误提示符合 Python 的最佳实践

3. 增加测试覆盖率

描述：为现有的图表类增加单元测试，提高测试覆盖率，确保代码质量。

涉及文件： - test/test_line.py - test/test_interval.py - 其他覆盖率较低的图表测试文件（pyantv 不再单独维护 Pie 类，饼图通过 Interval + 极坐标实现）

预计工作量：4-5 小时

实现指引： 1. 运行 pytest --cov=./ test/ 查看当前的测试覆盖率 2. 选择覆盖率较低的图表类 3. 为该图表类编写单元测试，覆盖各种使用场景 4. 确保所有测试都能通过 5. 再次运行覆盖率检查，确认覆盖率有所提升

🟡 Medium

4. 新增图表类型示例

描述：为尚未有示例的图表类型创建完整的示例代码，展示该图表的各种功能和配置选项。

涉及文件： - example/ 目录下的新示例文件

预计工作量：5-6 小时

实现指引： 1. 查看 example/ 目录，找出没有示例的图表类型 2. 选择一个图表类型（如 Chord、Sankey、Treemap 等） 3. 创建示例文件，文件名格式为 <chart_type>_example.py 4. 示例应包含：基础用法、数据准备、各种配置选项 5. 运行示例生成 HTML 文件 6. 确保示例代码清晰易懂，有适当的注释

5. 优化文档结构

描述：重新组织文档结构，使其更加清晰易读，提高文档的可维护性。

涉及文件： - docs/ 目录下的所有文档文件 - mkdocs.yml

预计工作量：4-5 小时

实现指引： 1. 审查当前的文档结构 2. 识别可以改进的地方（如重复内容、逻辑不清等） 3. 重新组织文档结构，确保逻辑清晰 4. 更新 mkdocs.yml 配置文件 5. 添加适当的导航链接 6. 确保所有文档链接正确有效 7. 本地运行 mkdocs serve 验证文档渲染效果

6. 添加交互功能示例

描述：创建展示 pyantv 交互功能的示例，如事件绑定、交互预设等。

涉及文件： - example/ 目录下的新示例文件 - docs/quick-start.md

预计工作量：5-6 小时

实现指引： 1. 查看 pyantv 的交互功能文档 2. 创建展示事件绑定的示例 3. 创建展示交互预设的示例（如 with_element_highlight()、with_brush_filter() 等） 4. 在快速开始文档中添加这些示例 5. 确保示例代码清晰易懂 6. 运行示例验证功能正常

如何开始

  1. 选择任务：从上面的列表中选择一个你感兴趣的任务
  2. 声明任务：在对应的 Issue 下留言，表示你要处理这个任务
  3. 开始工作：按照实现指引开始编写代码
  4. 提交 PR：完成后创建 Pull Request，并在 PR 描述中引用对应的 Issue
  5. 等待审查：维护者会审查你的 PR，可能会提出修改建议
  6. 合并：审查通过后，你的 PR 会被合并到主分支

需要帮助？

如果在任务过程中遇到任何问题，可以通过以下方式获取帮助：

感谢你的贡献！