新贡献者指南#

本指南是为新贡献者提供的 Apache Arrow 贡献资源。

无论您目前具备何种技能，都可以尝试为 Arrow 做出您的首次贡献。

开始为一个像 Apache Arrow 这样的项目做贡献可能会让人感到畏惧。采取小步骤将使这项任务变得更容易。

为何为 Arrow 做贡献？#

您想要为 Arrow 贡献的原因可能多种多样

  • 您觉得这个项目很有趣，并希望尝试做出贡献，以更多地了解这个库并提升您的技能。

  • 您正在一个项目中使用了 Arrow，并希望实现一个新功能或修复您遇到的一个错误。

在架构概述部分阅读更多关于项目的信息。

注意

Apache Arrow 的贡献者遵循 ASF 的行为准则。

快速参考#

以下是配置环境并为 Arrow 做出贡献所需的基本步骤。这既可作为核对清单，也可提供流程的整体概览。

如需完整说明，请遵循创建您的第一个 PR 的步骤（分步指南）或 R 和 Python 的教程，其中包含了添加基本功能的示例。

  1. 安装和设置 Git，并 fork Arrow 仓库

    有关如何设置 Git 和 fork Arrow 仓库的详细说明，请参阅相关文档。

  2. 构建 Arrow

    Arrow 库包含广泛的功能，可能需要安装第三方软件包，具体取决于您启用的构建选项和组件。C++ 构建指南对常见问题提供了建议——您可以在此处找到它。任何时候遇到困难，请随时通过适当的沟通渠道联系我们。

    查看有关PyArrow 或 R 软件包构建过程的简要说明，或直接前往文档中关于如何构建 Arrow 库之一的详细说明。

  3. 运行测试

    我们应该运行测试以检查一切是否正常工作。例如，您可以在终端中为 Python 运行测试

    $ pytest pyarrow

    或在 R 控制台中为 R 运行

    devtools::test()

    另请参阅关于测试 🧪的部分。

  4. 找到一个问题（如果需要），创建一个新分支并解决该问题

    寻找问题

    您可能已经想到了要修复的错误，或想要实现的新功能。但如果您还没有，并且需要一个问题来着手，那么您可能需要帮助来找到它。请阅读寻找适合初学者的问题 🔎部分以获取一些想法。

    在项目中找到自己的方向

    开始一个新项目的第一步是最困难的，因此我们编写了一些指南来帮助您。

    您可以从阅读在 Arrow 代码库上工作 🧐部分开始。

    沟通

    沟通非常重要。您可能需要一些帮助来解决路上遇到的问题（这对开发者来说是常有的事）。此外，如果您想解决某个 GitHub 问题，建议告知团队您正在处理，并可能需要一些帮助。

    查看可能的沟通渠道。

  5. 一旦您实现了计划的修复或功能，请为其编写并运行测试

    有关如何测试的详细说明，请参阅相关文档。在进入下一步之前，还请运行 linter 以确保代码样式正确！

  6. 将分支推送到您的 fork 并创建一个拉取请求 (Pull Request)

    有关创建一个拉取请求的详细说明，请参阅相关文档。

如果您已准备好，可以开始构建 Arrow，或者选择遵循关于编写 R 绑定或 Python 功能的教程之一。

不同的贡献方式#

除了编写代码，还有许多方式可以为项目做出贡献！

  • 改进文档是开始贡献的绝佳方式！更多信息请访问指南的帮助编写文档部分。

  • Apache Arrow Cookbook 是解决各种问题和使用 Apache Arrow 完成不同任务的食谱集合。它们也是开始贡献的好方法。更多信息请访问位于 Apache Arrow Cookbook 仓库中的如何为 Apache Arrow Cookbook 做贡献。

也欢迎您查看附加信息和资源部分。

我们鼓励每个人都为 Arrow 做出贡献！

完整目录#