Github 开源项目贡献指南:项目维护者的最佳实践

原文【Open Source Guides——Best Practices for Maintainers】

作为一个项目的维护者意味着什么

如果你维护者一个很多人都在用的项目,你可能就会意识到你写代码的时间变少了而回答issue的时间变多了。

在项目开始之初,你会不断尝试着实现自己的新想法,在知道自己 想要什么的基础上决定项目的走向。一旦你的项目开始流行之后,你会发现你的大部分时间都花在和用户以及贡献者打交道上。

维护一个项目需要的不仅仅是写代码的能力。有些时候会有一个你意想不到的的事情要应付,但是这对一个项目的成长也很重要(相对于代码来说),我们收集了一些小技巧来让你的生活变得更轻松,从写文档到管理社区。

记录项目的进展

对于一个项目的维护者来说写文档是最重要的事情之一。

文档不仅说清楚了你的想法是什么,而且还帮助别人在问问题之前理解你需要什么和接下在希望做什么。

即使你不想长篇大论,对要点略说一二也比啥都不写要好。

写下你的项目的发展方向

从写下你的项目目标开始。把他们加到README, 或者创建一个单独的VISION文件。如果还有什么其他的老古董能帮助人们了解这方面的信息,比如项目管理路线图,也把他们公开吧。

有一个明确的,用文档写清楚的方向能保证你不跑偏,也不会因为其他的贡献者增加一个奇怪的需求。

比如,@lord 发现有项目有一个明确的发展方向会帮助他决定哪个PR值得花时间。作为一个维护者的新手,他甚至还后悔当他接到第一个关于slate)PR的时候没有坚持它项目本身的原则。

我一直都在摸索。我没有努力寻求一个完整的解决方案。与其采用那种半吊子办法,我真希望曾经对某些Issue的提出者说:我暂时没有时间干这个,但是我会把他放到我的待办事项中。 — @lord, “Tips for new open source maintainers”

和大家交流你自己对项目的期望

制定规则是很伤脑筋的。有时候你可能觉得你像是在限制别人的行为或者说把好玩的东西都搞没了。

制定了规则,然后严格执行,当然啦,好的规则会让维护者更轻松。他们会把你从做自己不愿意做的事情中解脱出来。

大多数知道你项目的人对你或者你的处境都是一无所知。他们可能会觉得你做这个项目是有钱拿的,特别是你的项目是他们经常用的而且某种程度上有点依赖的时候。其实你只是在有时候会在项目上花很多时间,但是现在你在忙着安置新工作或者照顾刚出生的儿子。

这些都是再正常不过的事情!所以雀斑别人也知道这点。

如果你维护某个项目是临时的或者完全自愿的,能花多少时间就花多少时间。而不是你觉得项目需要你花多少时间或者别人想让你花多少时间。

这里是一些值得你写进项目里的东西:

  • 怎样的贡献才会被复查和接受(需要测试吗?提Issue有模板吗?)
  • 你希望有什么类型的贡献?(你是不是只希望在某些部分的代码上需要别人的帮助?)
  • 在合适的时候跟进项目(比如说 如果你在七天之内没有收到maintainer的回复,那就先干别的去吧)
  • 你会在这个项目上话多少时间(比如说 “我们每星期只会在这个项目上花5个小时“)

Jekyll, CocoaPods, and Homebrew 这是一些给维护者和贡献者制定了基本规则的项目例子.

保证交流公开

不管是什么时候,保证你的交流实在公共的场所(就是大家都看的地方)。如果有人尝试私聊你讨论一个新的需求或者功能,礼貌的引导它到公共的交流场所,比如邮件列表或者iuuse tracker。

如果你和别的维护者面基了,或者在私下做了一个很重要的决定,把这些信息告诉大家,即使只是把你的笔记发上去。

这样的话,每个人新加入到你们社区的人和已经呆了几年的人能够了解到的信息是一样的。

学会说不

文档你也写好了。理论上讲,每个人应该都会阅读你的文档,但是实际上,你总是要提醒有些小伙子他问的东西已经有答案了。

把所有的事情都写下来,当然,对你执行你制定的规则的时候客观分析实际情况也有帮助。

拒绝别人没啥意思,但是“你的贡献不符合这个项目的标准”比“我不喜欢你的贡献”要好听。

作为一个维护者,在很多情况下,你都要拒绝别人:不符合项目规则的PR, 某个人脱离了讨论的重点,给别人做无关紧要的工作。

保持友好沟通

你要学会拒绝的最重要的一个地方就是Issue和PR请求。作为一个项目的维护者, 你会不可避免的收到你不想接受的建议。

可能某个贡献改变了项目范围或者和你的期望不合。可能想法很好,实现的很烂。

不管是什么原因,在处理这些不符合项目标准的贡献的时候都要婉转。

如果你收到了你不想接受的贡献,你的第一反应可能是忽略或者假装没看到。但是这么做会严重伤害到别人而且可能会让你社区里的其他贡献者失去动力。

管理大型开源项目的关键就是保证issue活跃。尽量避免让issue停滞不前。如果你是一个IOS开发者,你会知道提交雷达是多么让人沮丧(我也不知道这是什么意思。。)你可能过了两年之后有人让你兼容一下现在的IOS版本。 — @KrauseFx, “Scaling open source communities”

别因为自己感到内疚或者想做一个好人就把你不想接受的贡献继续保留。随着时间的流逝,这些你没有回答的issue和PR会让你觉得很不爽。

更好的方式是马上关掉你不想接受的贡献。如果你的项目已经保守积压的issue的折磨,@steveklabnik可以给你点儿建议,how to triage issues efficiently.

第二点,忽略别人的贡献给社区传递了一个负面的信号。让人感觉做一个贡献是很吓人的事情,特别是对于新手来说。即使你不接受他们的贡献,告诉他们为什么然后致谢。这会让人觉得更舒服。

如果你不想接受某个贡献:

  • 感谢他们 的贡献
  • 解释为什么他们的贡献不符合项目的需求范围,然后提供清楚的建议以供改善,如果你可以的话。和蔼一点,但同时也要讲原则。
  • 引用相关的文档, 如果你有的话。如果你发现你反复收到你不想接受的贡献,把他们加到文档以免你重复叙述。

你不需要用超过1-2两句话来回复。比如,当一个celery的用户报告了一个window相关的错误,@berkerpeksag 是这么回复的

如果你感觉拒绝别人很不好意思,也很正常,其实很多人都是这样。就像 @jessfraz 说到的:

我和很多来自诸如Mesos, Kubernetes, Chromium等不同开源项目的维护者交流过,他们都异口同声的觉得做一个维护者最难的就是拒绝你不想打补丁。

对于不想接受别人的贡献这件事不要感到愧疚。如 @shykes所说开源的第一原则就是 “拒绝是暂时的,接受是永远的”当然啦,认同别人的热情还是一个好事,拒绝他的贡献和拒绝他这个人是两码事。

最后,如果一个贡献不是够好,你没任何义务接受它。对那些想对你的项目做贡献的人保持和蔼和积极的态度,但是只能接受那些你确定会让你的项目变得更好的提交。你说拒绝的次数越多,对你来说拒绝别人就越容易。谨记!

保持主动

要想减少你不想接受的贡献的数量,首先,在你项目的贡献指南中解释如何提交贡献以及怎样的贡献会被接受。

如果你收到太多低质量的贡献,让那个贡献者先多做做功课,比如:

  • 填写一个issue或者PR的模板/清单
  • 在提交PR之前先开一个issue

如果他们不遵从你的规则,马上关掉issue病并引用你的文档。

当然啦这么搞一开始是不太舒服,但是你主动一点确实对双方都好。它减少了某个人花了太多事件到一个你不想要的PR上的可能性。而且让你管理起来更容易。

理论上,在CONTRIBUTING.md文件里面告诉别人在他们开始干活之前如何更清楚的知道的干完之后会不会被接受。 — @mikemcquaid, “Kindly Closing Pull Requests”

有时候,当你说不的时候,你潜在的贡献者会感到对你的沮丧或者不爽。如果他们开始找你撕逼了,take steps to diffuse the situation或者干脆把他们从你的社区开除,如果他们不打算和你保持建设性的合作关系的话。

接受指导

可能在你的社区里有人不断提交一些不符合项目需求的贡献。对你们双方来说不停的拒绝他的提交都很尴尬。

如果你发现有人对你的项目很上心,但是就是需要调教,那就耐心一点。给他解释明白每次它的提交为什么不符合项目需求。尝试着让他先做一些简单一点的事,比如那些标有“good first bug”标签的issue,以此让他慢慢习惯。如果你有时间的话,考虑教他怎么完成第一次贡献,或者在社区找一个人教他。

利用社区的力量

你不需要凡事亲力亲为。这就是社区存在的原因!即使你没有一个活跃的贡献者社区,但是如果你有很多用户的话,拉他们来干活儿。

分担工作量

如果你正在寻找其他人来参与, 从身边的人开始。

当你看到新的贡献者不停的提交贡献,通过分配给他们更多任务来表示认可。如果别人愿意的话,记录下别人是怎么成长为领导者的过程。

鼓励别人来一起管理项目能很大程度上减轻你的工作量,就像 @lmccart在他的项目上做的那样,p5.js

我曾经说过,“对,每个人都可以参与进来,你不需要有很多编程的经验。”当有申请来参加我们的活动的时候,我就在想,这是真的吗,我说了啥?有将近40个人来了,我虽然不可能和每个人都单独交谈,但是大家一起来了,这说明我说的没错。只要有人知道怎么做了,他们就能教他们的邻居。 — @lmccart, “What Does “Open Source” Even Mean? p5.js Edition”

如果你需要暂时或者永久的离开的项目,大可找人来代替你。

如果别人认同项目的发展方向,给他们提交的权限或者正式把项目所有权转移给他。如果有人fork了你的项目而且在保持活跃的维护,考虑在你的原始的仓库放上这个fork版本的链接。如果大家都希望你的项目继续的话这不失为一种好办法。

@progruim 发现 由于它给他的项目Dokku写一个关于项目发展方向的文档,即使在它离开这个项目后他的那些目标仍然会被实现。

我写了一个wiki来描述我想要啥和为什么。不知道为啥,项目的维护者就开始推动项目朝那个方向发展,这对我来说还是有点惊讶的。他们会一点不差的按照我的意愿去做这个项目吗?不总是这样,但是总是会把项目推动到离我的理想状态更近的位置。

让别人尝试他们自己想要的解决方案

如果有贡献者关于项目有不同的意见,你可以礼貌的鼓励它在他自己fork版本上继续工作。

fork一个项目不什么坏事情。能复制并且修改别人的代码是开源项目最大的好处之一。鼓励你的社区成员在他自己fork的仓库上继续工作是在不和你的项目冲突的基础上,给实现他们的想法最好的出口。

我迎合80%的用户需求。但是如果你是那20%中的一个,那么fork我的项目吧。我不会介意的!我的公开的项目是用来解决那些最常见的问题的。我尝试着让别人fork我的项目然后在上面拓展得更加简单。 — @geerlingguy, “Why I Close PRs”

这对于那些强烈的需要某个你没时间实现的解决方案的用户来说也是一样的。提供API或者自定义的钩子帮助他们更好的实现自己的需求而不需要改动源码。@orta发现鼓励在CocoaPods上使用插件导致了很多有趣的想法的诞生。

一旦一个项目变大之后,维护者对怎么增加新代码变得保守是不可避免的事情。你可能很会拒绝别人的需求,但是很多人提的都是合法的需求。所以,你不得不把你的一个工具变成平台。

使用机器人

就像很多工作别人可以帮你做一样,也有很多工作不需要人来做。机器人是你的朋友,用他们让你的维护者生活变得更容易。

引进测试和别的检查来改善你的代码质量

让你项目自动化的最重要的方法之一就是引进测试。

测试能够帮助贡献者自信他们没有弄坏什么。测试也让你复查代码和接受别人的贡献的过程更加容易。你反应的越多,社区参与的就越多。

设置自动化的测试让所有新来的贡献者都可用,而且保证你的测试可以很容易在贡献者的本地运行。保证所有的代码贡献者在提交之前都运行你的测试。你还得为所有的提交设置一个基本的标准。

如果你添加了测试,确保在CONTRIBUTING文件里面解释他们是怎么工作的。

我相信测试对所有的代码都是需要的。如果代码被完整的覆盖了测试,以后就不需要改了。我们只需要在代码崩溃或者需要某个功能的添加代码。不管你在修改什么,测试对于检查那些你可能不小心制造的问题都是必须的。 — @edunham, “Rust’s Community Automation”

用工具来自动化日常的维护工作

对于维护一个流行的项目来说,一个好消息是别的维护者也可能遇到过类似的问题而且已经找到一个解决方案。

这里有各种各样的工具帮你自动化一部分的维护工作。一些例子i:

对于bug报告和其他常见形式的贡献,Github有Issue Templates and Pull Request Templates, 你可以用来降低沟通成本。你也可以设置邮件过滤来管你你的邮件提醒。

如果你想逼格更高,代码风格指南和linter能让你项目收到的贡献更规范,而且更同意复查和接受。

当然啦,如果你的标准太复杂了,反倒会增加了贡献的难度。所以保证你只添加一个让每个人工作起来更容易的规则。

如果你不确定用什么工具,看一看别的流行项目是怎么做的,特别是和你在一个生态系统的。比如,其他的Node模块的贡献流程是怎么样的?用想死的工具和方法会让你项目的贡献流程对贡献者更熟悉。

不干了也没关系

开源项目曾经让你开心,但可能现在开始让你不开心了。

可能当你想到你的项目的时候感觉到亚历山大。而同时,issue和PR又纷至沓来。

疲倦在开源工作工作中是一个常见的问题,特别是在维护者中间。作为一个维护者,你做的开心对项目的生存来说是一个没有商量余地的条件。

虽然你不需要跟谁请假,但是也不腰拖到自己疲倦不堪的时候才去度假。@brettcannon,一个python的核心开发者,决定在14年的义务劳动之后休一个月的假

就像其他工作一样,有规律的休息会让你对工作保持舒适愉快的心情。

我发现最好的平衡点就是每周在日常的工作安排中花2-5小时在这上面。这会让我从感觉太累到保持持续的激情。因为我给我需要解决的issue表上了优先级,从而我能够在我认为重要的事情上有所进展。 — @danielbachhuber, “My condolences, you’re now the maintainer of a popular open source project”

我是WP-CLI的维护者,我发现我需要首先让自己开心,在开源项目和其他事情之间设定清楚的界 有时候,当你感觉大家都离不开你的时候请假去休息是一件很难的事情。甚至人们会让你因为离开而感到愧疚。

在你离开项目的时候尽可能的在用户和社区中间寻求支持,如果你找到支持你的人,还是休息吧。在你不工作的时候还是要保持和别人交流,这样人们不会因为你的失联感到奇怪。

休息并不只是独家。如果你周末不想做开源项目的工作了,或者在本该工作的时候不想干活了,和别人说,这样他们才知道这个时候不该打扰你。

首先照顾好自己!

维护一个大型项目需要和在项目开始成长时不同的技能。作为一个维护者,你会将自己的领导力和个人能力提示一个层次,而这是很少人能体会到的。但是与此同时,管理项目,设定清晰的界限,制作你感到舒服的事情会让你保持开心,活力,高产的状态。

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

编辑于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏架构师之路

创业电商产品四大要点【创业+产品】

创业电商产品四大要点 一、做好商品浏览功能 1)当公司规模还不大的时候,不必急急忙忙地推出搜索功能 2)产品库还不算丰富时,人们根本不知道该搜索什么,所以做好商...

3619
来自专栏刘望舒

最接地气的Android面试总结心得

作者:g小志 地址:https://www.jianshu.com/p/d800165da455 声明:本文是 g小志 原创,未经原作者允许请勿转载 前言 首...

3736
来自专栏编程

手持 Python 利剑,一路向前

学习 Python 课程究竟有什么用?Python 课程学员假牙运用课程所学,在工作中设置自动化检验脚本,为团队排除 bug 规避风险。「最难受的时候再坚持一下...

20410
来自专栏数据库新发现

拉里·埃里森亲自支招,数据库自动化之后,DBA何去何从?

作者:eygle |English 【转载时请标明出处和作者信息】|【恩墨学院 OCM培训传DBA成功之道】 链接:http://www.eygle.com...

1523
来自专栏灯塔大数据

数据的阴暗面:什么是暗数据?为什么暗数据很重要?

? 最近引起热议的术语暗数据,确切的说,就是来自于大数据的阴暗面。尽管暗数据这个名字听起来不吉利(让人联想到一个少年哥特乐队会取的绰号),但是或许更加的准确。...

3465
来自专栏AI研习社

一张图看懂数据科学;惊曝英特尔 72 核 Xeon Phi 处理速度 | 开发者头条

一张图看懂数据科学 72 核的英特尔 Xeon Phi,数据处理速度赶上 GPU? Linux 4.10 的三大改进之处 GitHub 邀请更多开发者参与其开...

3236
来自专栏程序人生

Tubi 为什么?

在一段旅程行将结束的时候,retrospective 是最好的临别礼物。Tubi 是一家独特的 startup,站在外人的角度,你很难想象这样一家不到三十个工程...

1460
来自专栏IT技术精选文摘

浅谈开发实时视频直播平台的技术要点

1852
来自专栏腾讯移动品质中心TMQ的专栏

众测实战经验小结

随着互联网浪潮的推进,手机 App 进入了高速发展期,随之而来 App 的“不可替代性”也越来越弱化。

2521
来自专栏魏艾斯博客www.vpsss.net

Vultr 取消支付宝付款方式

4072

扫码关注云+社区