新贡献者指南#
本指南是为新贡献者提供的一个关于如何为 Apache Arrow 做贡献的资源。
无论您目前的技能如何,您都可以尝试为 Arrow 贡献您的第一次。
开始为像 Apache Arrow 这样的项目贡献代码可能会让人望而生畏。采取小的步骤将使此任务更容易。
为什么要为 Arrow 贡献代码?#
您可能希望为 Arrow 贡献代码的原因有很多。
您发现该项目很有趣,并且想尝试为它做出贡献,以了解更多关于该库的信息并提升您的技能。
您在正在进行的项目中使用 Arrow,并且您想实现一个新功能或修复遇到的错误。
阅读更多关于该项目的信息,请参阅架构概述 部分。
注意
Apache Arrow 的贡献者遵循 ASF 的 行为准则。
快速参考#
以下是开始设置并为 Arrow 做贡献所需的几个基本步骤。这既是一份清单,也是对整个流程的概览。
有关完整说明,请参阅 创建第一个 PR 的步骤(分步指南)或 R 和 Python 教程,以获取添加基本功能的示例。
安装并设置 Git,并 fork Arrow 仓库
查看有关如何 设置 Git 并 fork Arrow 仓库的详细说明。
构建 Arrow
Arrow 库包括各种功能,可能需要安装第三方包,具体取决于您启用了哪些构建选项和组件。C++ 构建指南提供了一些常见问题的解决方案,您可以在 此处 找到它。如果您遇到任何问题,请随时通过合适的 沟通 渠道与我们联系。
查看有关构建 PyArrow 或 R 包 的简要描述,或者直接前往有关如何在 文档 中构建 Arrow 库的详细说明。
运行测试
我们应该运行测试以检查一切是否正常工作。例如,您可以从终端为 Python 运行测试
$ pytest pyarrow
或在 R 控制台中为 R 运行测试
devtools::test()
另请参阅有关 测试 🧪 的部分。
找到一个问题(如果需要),创建一个新的分支并解决问题
寻找问题
您可能已经心中有要修复的错误或要实现的新功能。但是,如果您没有,并且需要一个要解决的问题,那么您可能需要帮助找到它。阅读 寻找好的第一个问题 🔎 部分以获取一些想法。
熟悉项目
开始一个新项目的第一步是最难的,所以我们编写了一些指南来帮助您完成这一步。
您可以从阅读 在 Arrow 代码库上工作 🧐 部分开始。
沟通
沟通非常重要。您可能需要一些帮助来解决您遇到的问题(这种情况对所有开发人员来说都很常见)。此外,如果您要解决一个 GitHub 问题,那么建议您让团队知道您正在处理它,并可能需要一些帮助。
查看可能的 沟通 渠道。
一旦您实现了计划的修复或功能,就为它编写并运行测试
将分支推送到您的 fork,并创建一个拉取请求
查看有关 创建拉取请求 的详细说明。
如果您已准备好,可以开始构建 Arrow 或选择遵循 教程 中的其中一个教程,以了解如何编写 R 绑定或 Python 功能。
不同的贡献方式#
除了编写代码,还有很多方法可以为该项目做出贡献!
改进**文档**是一个很好的开始贡献的方式!有关更多信息,请访问本指南的 帮助编写文档 部分。
**Apache Arrow 食谱**是使用 Apache Arrow 解决各种问题和完成不同任务的食谱合集。它们也是一个很好的开始贡献的方式。有关更多信息,请访问 Apache Arrow 食谱仓库中的 如何为 Apache Arrow 食谱做出贡献。
您也可以查看 其他信息和资源 部分。
我们希望鼓励每个人为 Arrow 做贡献!