乐趣区

关于开源:拥抱开源指南

jiezi

本文作者：Likyh

个人主页：https://github.com/likyh

拥抱开源指南

近年来，开源正在变得越来越火，在很多开发者眼中，「开源」也是十分极客的体现。同时参加开源我的项目也能给职业倒退带来微小的益处。可一些小伙伴却因为不晓得参加的办法和路径没能参加，这里就向大家介绍一下作为开发者，能够怎么拥抱开源软件，以及怎么成为大家认可的开源贡献者。

当然，本文会更多的从大的背景常识上进行叙述，对于代码提交的具体步骤，能够看看这一篇文章：https://mp.weixin.qq.com/s/b1mKPgOm1mnwsBbEBDRvKw。

什么是开源软件

开源是源代码能够任意获取的计算机软件，任何人都能查看、批改和散发他们认为适合的代码，但这并不意味着能够应用源代码而没有任何著作权或发行权的束缚，咱们接触到的开源软件个别都有对应的开源许可证（Open Source License）对软件的应用、复制、批改和再公布等进行限度。许可证即受权条款，开源许可证就是阐明这些限度的文件，常见的开源许可证次要有 Apache、MIT、BSD、GPL、LGPL、MPL、SSPL 等。

上面，咱们通过一张表来简略理解一下常见 宽松 开源许可证之间的区别：

（图片来自: https://www.ruanyifeng.com/blog/2011/05/how\_to\_choose\_free\_software_licenses.html）

其中，Apache 许可证（Apache License）是目前寰球最大的开源软件基金会之一 ASF (Apache Software Foundation) 公布的 License。这是一个最后为 Apache http 服务器而撰写。此许可证最新版本于 2004 年 1 月公布，并要求所有 ASF 的我的项目均采纳此项 License。

寻找运行良好的开源我的项目

目前，开源我的项目次要是两类，一类由团队自行保护，一类由特定的基金会运行。当初大部分我的项目均托管在 GitHub 上，因而在 GitHub 上间接搜寻点赞较高较沉闷的我的项目，往往就是一个不错的抉择。比方想参加数据分析相干的我的项目，能够在 GitHub 搜寻 data analyzes，留神察看我的项目最近的提交工夫和 issue 数量，更新快阐明我的项目成员沉闷，有 issue 阐明是一个正在疾速倒退的我的项目，更适宜参加。

第二种寻找形式，由开源基金会保护的运行良好的我的项目，还能够在对应的开源基金会官网找到。

比方 Linux 基金会的我的项目地址：https://www.linuxfoundation.org/projects/

比方 CNCF 的我的项目页：https://landscape.cncf.io/

比方 ASF 的我的项目页：https://projects.apache.org/projects.html

最初，还有一些第三方的评估面板，从一些独特的视角理解现存的开源我的项目。比方 ossinsight：https://ossinsight.io/collections/open-source-database，能够理解本月点赞最多的我的项目有些什么，再比方从 DevLake 的 OSS 我的项目面板 更加深刻的理解我的项目，这都是理解开源我的项目运行状况的有效途径。

Apache 开源软件基金会

因为笔者更理解 ASF，所以这里就对它做一些更具体的介绍。

Apache 开源基金会目前保护着 380 余个开源我的项目，但一年的开销仅一百多万美元左右。这是一个非常低的数（而其余基金会比方 Linux 基金会，每年开销在上亿美元），均匀每个我的项目仅 2000 余美元，这就决定了 Apache 的开源我的项目更依赖社区和开源贡献者，在 Apache 社区中，「Community over Code」即社区先于编码体现得酣畅淋漓。Apache 基金会每年的收入其中 80% 用在 基础设施 ，其余会用在 营销、宣传和品牌治理服务，研讨会和倒退社区，法律咨询等方面，而其余诸如日常保护、编码等工作均由各个我的项目的成员保护。

Apache 开源我的项目中，个别有如下几个根本的角色：

  • Contributor 一般贡献者，这种就是很容易取得，只须要提交一个 PR 并被官网合并到主分支即可取得，例如提交一个文档，批改几行代码就行。
  • Committer 外围开发，对奉献特地大的 Contributor，官网社区会思考将其排汇，晋升到 commiter，成为外围开发，此时就有我的项目的写入权限，并能够申请 @apache.com 结尾的邮箱。
  • PMC 开源我的项目决策成员。

参加我的项目探讨

一旦抉择好一个开源我的项目后，咱们又该如何找到组织呢？

首先是浏览官网文档，全面理解该项目标架构设计文档和解决的问题，之后能够尝试参加我的项目日常的探讨。只管在微信群中发问很不便，但 Apache 我的项目的大部分探讨须要公开地在邮件列表中进行，不便所有人查看及查问，因而咱们也须要理解如何参加 Apache 的邮件探讨。

Apache 上面的每一个我的项目都有本人的邮件列表，同时分不同的邮件组，以 Apache DevLake 为例，有如下订阅列表：

邮箱 用处
user-subscribe@devlake.apache.org 订阅该邮件能够参加探讨普通用户遇到的问题
dev-subscribe@devlake.apache.org 订阅该邮件能够参加探讨 开发者 遇到的问题
commits-subscribe@devlake.apache.org 所有的代码的提交变动信息都会发到该邮件

具体操作是首先给 dev-subscribe@devlake.apache.org 发一封邮件，等收到确认邮件后再次确认即可。

增加后就能够收到所有开发探讨的信息了，另外也能够关注官网的 maillist(https://lists.apache.org/list.html?dev@devlake.apache.org) 查看全副历史邮件。

另外，大部分我的项目会有一些线上的团聚，往往能够在 Readme 页面找到，参加线上团聚能够更间接的获取所需的信息，也能有机会和我的项目 PMC 间接交换。

向开源我的项目反馈问题

如果在我的项目的应用中，遇到了 bug，或者心愿撸起袖子批改某个性能点，但这个性能点须要进一步探讨。能够在后面的邮件中发动探讨，当然也能够在 GitHub 的 issue 中做一个较正式的记录。

个别的我的项目都会针对不同的目标，提供一些 issue 创立的模板。

常见的类型有：

  • Bug 提出一个性能实现的谬误
  • Document Issue 提出一项文档改良的倡议
  • Feature Request 申请减少或示意你将减少一个产品个性
  • Refactor 发动一项不影响性能的重构
  • Security Vulnerability 报告一个平安问题，在问题修复以前，该问题不会颁布。

提出一个清晰明了的 issue 往往会让社区的其余成员更违心响应你的号召，置信我，这会是一个十分享受的过程~

成为我的项目的贡献者

在参加探讨的根底上，只有能在 GitHub 社区中帮忙验证一些公布的新性能或者提一些倡议或者缺点，或者批改源码，就能成为该项目标贡献者(Contributor)。

刚参加我的项目时，能够思考编写文档，或欠缺一些模块的单元测试，或者进行一些简略编码工作。比方能够在 GitHub Issues 列表中寻找带有 good first issue 标记且暂未被认领的事件，这往往是社区维护者为了疏导贡献者专门创立的 issue，很适宜作为第一个提交。实现第一个提交后，能够再去看看其余 open 的 issue 并解决。

目前开源我的项目个别采纳 Git 来治理源代码，如果你从未应用过代码管理工具的话，能够当初网上寻找教程理解，比方：https://www.liaoxuefeng.com/wiki/896043488029600。个别的提交流程是：先 fork 对应的我的项目，在 fork 我的项目提交代码后，向开源我的项目发动代码合并申请期待合并。

须要留神的是，任何代码提交后，都不会立即合并，须要寻找社区维护者 Review 后才会进入骨干。

编写好代码的注意事项

代码不是写完就好，还须要其他人浏览的。因而，写出赏心悦目的代码很值得点赞，当然，程度的晋升总是有一个过程，因而任何开源我的项目都是激励尝试与晋升的过程。这里就只说几点更容易失去社区成员帮忙的注意事项：

  1. 写完代码提交 PR 后，留神在 PR 形容中补充欠缺的编码思路和背景常识，这会让其余成员更容易理解批改指标；
  2. 留神管制 PR 的大小，一个小的 PR 更容易让其他人理解全副批改项，如果有一个大的性能，能够依照模块拆成几个能别离运行的 PR；
  3. 留神补充适当的单元测试，因为 Reviewer 并不负责确定代码能跑，只负责看代码设计思路是否正确。因而减少适合的测试，能让 Reviewer 确定这段代码是能够运行的。有时 Reviewer 也会针对容易出错的中央提出补充测试的倡议。

Code Review 常见术语

在提交代码与 Code Review 的过程中，有时会遇到上面这些缩写，理解后参加开源社区更轻松。

缩写 全称 应用场景
– I’ll take it. 示意会尝试做这个工作
PR/MR/CR Pull/Merge/Change Request 如果要提交代码给开源我的项目，就会发动一个合并申请，在不同平台有不同的名字，但都是同一个货色
WIP Work In Progress 示意 PR 尚未实现，临时还不须要 review
PTAL Please Take A Look 申请我的项目保护人员进行 code review
TBD To Be Done 提醒有一个事件须要实现
TL;DR Too Long; Didn’t Read 太长了，懒得看。也有时在文档中用作概览信息的题目
LGTM/SGTM Looks/Sounds Good To Me 示意 review 完并感觉能够合并了，即 Approve 的意思
CC to Carbon Copy to 抄送给

顺便再说几个 GitHub 中实用的小技巧：

  1. 如果你的 PR 解决了某个 issue，能够在形容中加上 close #1234，1234 须要改成对应的 issue 号，在 PR 合并时该 issue 也会同时敞开（更多信息）
  2. GitHub 的 Markdown 编辑器能够将默认字体设置为等宽字体，便于代码的书写，具体设置为：Settings – Appearance – Use a fixed-width (monospace) font when editing Markdown.（更多信息）
  3. 当发现一个 issue 和其余 issue 反复时，能够设置在评论区留下 Duplicate of #1234 来标记与某个 issue 反复（更多信息）

结语

好啦，大体的状况应该介绍的差不多了，其实参加开源我的项目并没有设想中的难，成为一个开源我的项目的 Commiter，给职场和技术实力带来的助力将不可估量。另外，如果你还是较为高级的开发者，迫切的想要晓得具体的参加步骤，能够看看结尾提到的这篇文章：https://mp.weixin.qq.com/s/b1mKPgOm1mnwsBbEBDRvKw。

咱们的 DevLake (https://github.com/apache/incubator-devlake) 和 DevStream (https://github.com/devstream-io/devstream) 也是优良的开源我的项目，欢送你的参加哦~

理解更多最新动静

官网：https://devlake.incubator.apache.org/

GitHub：https://github.com/apache/incubator-devlake/

Slack：通过 Slack 分割咱们

退出移动版