[Flink课程]---- 1.3 怎样在Flink社区做贡献？

介绍

Flink是第三代计算引擎，相比spark，它有许多优势，同时汲取了storm流式处理的优点。

怎样贡献代码给社区

1、问问题

Apache Flink社区非常乐意帮助并回答您的问题。他们有一个用户邮件列表，并在[apache-flink]标签上观看Stack Overflow。

2、提交Bug信息

如果您遇到Flink问题并提交错误报告，请告诉他们。打开Flink的Jira，必要时登录，然后单击顶部的红色“ 创建”按钮。请提供您遇到的问题的详细信息，如果可能，请添加有助于重现问题的说明。非常感谢你。

3、提出改进或者新特性

社区一直在寻找反馈来改进Apache Flink。如果你有一个想法如何改进Flink或有一个对Flink用户有益的新功能，请在Flink的Jira中打开一个问题。应详细描述改进或新功能，并尽可能包括范围及其要求。详细信息很重要，原因如下：

• 它可确保在实施改进或功能时满足您的要求。
• 它有助于估算工作量并设计满足您需求的解决方案。
• 它允许围绕这个问题进行建设性的讨论。

如果您计划自己提供改进或功能，则还需要提供详细信息。在这种情况下，请阅读Contribute代码指南。

在开始实施之前，我们建议首先与社区就是否需要新功能以及如何实施新功能达成共识。某些功能可能超出了项目范围，最好尽早发现。

对于从根本上改变Flink的非常大的功能，我们有另一个流程： Flink改进提案。如果您有兴趣，可以在那里提出新功能或遵循现有提案的讨论。

4、帮助他人并加入讨论

Apache Flink社区中的大多数通信都发生在两个邮件列表中：

• 用户邮件列表[email protected]是Apache Flink用户提出问题并寻求帮助或建议的地方。加入用户列表并帮助其他用户是为Flink社区做出贡献的一种非常好的方式。此外，如果您想在那里帮助Flink用户（并获得一些积分），Stack Overflow上还有[apache-flink]标签。
• 开发邮件列表[email protected]是Flink开发人员交换想法并讨论新功能，即将发布的版本以及一般开发过程的地方。如果您有兴趣为Flink贡献代码，您应该加入此邮件列表。

非常欢迎您订阅这两个邮件列表。

5、测试预发布版本

Apache Flink的活跃社区不断改进。每隔几周，他们就会发布一个新版本的Apache Flink，其中包含错误修复，改进和新功能。发布新版本的过程包括以下步骤：

• 建立新的候选人并开始投票（通常为72小时）。
• 测试候选发布版和投票（+1如果没有发现问题，-1发布候选版本是否有问题）。
• 如果候选发布版有问题，请返回第1步。否则他们发布该版本。

他们的wiki包含一个页面，总结了发布的测试过程。如果由一小群人完成发布测试是一项重大工作，但可以轻松扩展到更多人。Flink社区鼓励每个人参与测试候选发布版。通过测试候选版本，您可以确保下一个Flink版本正常运行，以帮助您进行设置并帮助提高版本质量。

6、贡献代码

Apache Flink通过volunteers 的代码贡献得到维护，改进和扩展。Apache Flink社区鼓励任何人贡献源代码。为了确保贡献者和审阅者的愉快贡献体验并保持高质量的代码库，我们遵循我们的Contribute代码指南中解释的贡献过程。该指南还包括有关如何设置开发环境，编码指南和代码样式的说明，并说明如何提交代码贡献。

在开始编写代码贡献之前，请阅读Contribute代码指南。

另请阅读提交贡献者许可协议部分。

正在寻找一个可以解决的问题？

我们在Flink的Jira中保留了所有已知错误，建议的改进和建议功能的列表。我们认为对新贡献者来说是好任务的问题标有一个特殊的“入门”标记。这些任务应该很容易解决，并将帮助您熟悉项目和贡献过程。

如果您正在寻找可以解决的问题，请查看启动器问题列表。您当然也可以选择任何其他问题。您可以随意提出有关您有兴趣处理的问题的问题。

7、贡献文档

良好的文档对任何类型的软件都至关重要。对于复杂的软件系统尤其如此，例如Apache Flink等分布式数据处理引擎。Apache Flink社区旨在提供简明，精确和完整的文档，并欢迎任何改进Apache Flink文档的贡献。

• 请将缺失，不正确或过时的文档报告为Jira问题。
• Flink的文档是用Markdown编写的，位于Flink源代码库的docs文件夹中。有关如何更新和改进文档以及提供更改的详细说明，请参阅Contribute文档指南。

8、改善网站

在Apache flink webstie呈现的Apache flink和它的社区。它有多种用途，包括：

• 向访问者介绍Apache Flink及其功能。
• 鼓励访问者下载并使用Flink。
• 鼓励游客与社区互动。

我们欢迎任何改进我们网站的贡献。

• 如果您认为我们的网站可以改进，请打开Jira问题。
• 如果您想更新和改进网站，请按照改进网站指南进行操作。

9、更多贡献方式......

还有很多方法可以为Flink社区做出贡献。例如，你可以：

• 谈谈Flink并告诉别人你如何使用它。
• 组织本地Meetup或用户组。
• 与人们谈论Flink。
• ...

10、提交Contributor许可协议

如果您想向Apache Flink投稿，请向Apache Software Foundation（ASF）提交参与者许可协议。

来自http://www.apache.org/licenses的以下引用提供了有关ICLA和CCLA的更多信息以及它们为何必要。

ASF希望Apache项目的所有想法，代码或文档的贡献者完成，签署并提交（通过邮寄，传真或电子邮件）个人贡献者许可协议（CLA）[ PDF表格 ]。本协议的目的是明确界定知识产权向ASF提供的条款，从而允许我们在未来某个时候就软件发生法律纠纷时为项目辩护。在为个人提供ASF项目的提交权限之前，必须将已签名的CLA存档。

对于已指派员工从事Apache项目工作的公司，公司CLA（CCLA）可通过公司提供知识产权，这可能已被指定为就业协议的一部分。请注意，公司CLA不会消除每个开发人员作为个人签署自己的CLA的需要，以支付他们不是由签署CCLA的公司所拥有的任何贡献。

...

11、如何成为一名commiter

Committers是具有对项目存储库的写访问权的社区成员，即他们可以自己修改代码，文档和网站，也可以接受其他贡献。

成为Committers没有严格的协议。新Committers的候选人通常是活跃的贡献者和社区成员。

作为一个活跃的社区成员意味着参与邮件列表讨论，帮助回答问题，验证候选发布者，尊重他人，并遵循社区管理的精英原则。由于“Apache Way”非常关注项目社区，因此这一部分非常重要。

当然，为项目提供代码和文档也很重要。一个好的开始方法是提供改进，新功能或错误修复。您需要证明您对所贡献的代码负责，添加测试和文档，并帮助维护它。

新提交者的候选人由当前的提交者或PMC成员提出，并由PMC投票。

如果您想成为Committers，您应该与社区互动，并开始以上述任何方式为Apache Flink做出贡献。您可能还想与其他Committers交谈，并征求他们的建议和指导。

 

英文原文：https://flink.apache.org/contributing/how-to-contribute.html