如何贡献

5 种无需编程即可为科学 Python 贡献的方法#

科学 Python 是由科学家和工程师为科学和工程设计的代码。所有项目都有一个简单的许可证,决定你可以做什么,不能做什么;通常,你可以使用和修改软件,只要你对原始作者表示感谢。整个生态系统依赖于同行评审和社区生产,因此你的贡献非常重要。除了编码之外,还有许多其他方式可以做出贡献——我们将讨论其中的一些。

问题测试、复现和分流#

每个科学 Python 项目都有自己的问题跟踪器,用户可以在其中报告错误、建议用户体验改进,以及讨论他们遇到的技术问题。这使开发人员能够为用户提供支持,并跟踪对项目的改进。你可以通过验证和分流问题来做出贡献。

例如

  1. 你可以检查较旧的问题是否仍然相关,并让开发人员知道是否已解决。
  2. 你可以找到重复的问题并将相关问题链接起来,因为通常同一个问题会被报告多次。
  3. 你可以添加包含所有代码片段,这些片段可以重现问题,从而帮助开发人员找到问题并测试解决方案。
  4. 你可以通过添加合适的标签来标记问题。这通常需要分流权限,但你可以直接申请!

审查 PR#

拉取请求(PR)是科学 Python 项目整合新代码的方式。即使你不太熟悉它们,你也可以通过以下方式提供帮助。

  1. 总结 PR 中的讨论,以便新人可以轻松地跟上讨论,而无需阅读整个线程。
  2. 测试 PR 中提出的更改,以确保它们正常工作并且不会破坏现有代码。

改进文档#

另一种为项目做出贡献的方法是改进它的文档。文档对于每个科学 Python 项目都至关重要,因为它是用户学习如何使用它的方式。这并不意味着你需要编写新的文档(你可以按照文档贡献指南进行操作),但还有其他方法可以提供帮助。

  1. 许多项目都有教程,你可以审查这些教程并报告其中令人困惑或缺失的部分。
  2. 在文档中查找错别字和小的错误,并在文档存储库问题跟踪器中报告它们。
  3. 为文档化的函数添加代码示例。
  4. 为了确保功能,请测试文档中提供的现有代码示例。请记住,偶尔的版本升级可能会导致代码示例出现故障。
  5. 如果你想创建自己的内容,你可以编写自己的指南和教程。你可以制作多种类型的材料:操作指南、深入解释、示例库、笔记本、视频等。
  6. 除了内容外,你还可以改进文档的组织和风格。

翻译#

大多数科学 Python 项目都是用英语开发的,但越来越多的项目使用像 Crowdin 这样的在线平台来翻译他们的界面、网页和文档。

如果你说英语以外的语言,并且感觉自己能够胜任翻译工作,那么这将是你可以提供的另一种帮助方式。

你还可以通过用母语创建入门教程和指南来帮助你周围的本地开发人员。

参与社区#

每个科学 Python 项目都有一个用户、开发人员、维护人员、贡献者和志愿者组成的社区,你可以成为其中一员。

你可以通过以下方式参与社区

  1. 加入讨论论坛(Discourse、Discord、Gitter、Slack 等)
  2. 参加社区会议和办公时间
  3. 社交媒体宣传 - 推特/Mastodon/LinkedIn/Instagram
  4. 撰写博客文章
  5. 如果你熟悉该项目,可以通过回复问题来帮助新人
  6. 发布时事通讯更新
  7. 组织代码冲刺和黑客马拉松

正如你所见,有许多方法可以为科学 Python 做出贡献!无论你有什么可以提供的,请与项目维护人员联系:他们会很乐意接受他们能得到的所有帮助。

本页