← 高小猫

如何经营好一个开源项目

最近换了新的工作,新工作的主要内容是帮忙开发一个开源项目。因为开源项目的目标人群是广大的第三方开发者,因此不同于公司内部的代码库,核心开发者会有大量的时间用在改善文档,改善代码,以便增进项目的易读性以及易用性,以便于第三方开发者使用以及进一步回馈整个社区。


为了增进易读性以及易用性,开发时为了实现同样功能的代码,需要花费的时间以及精力可能是原本的好几倍。对于我们当前的这个开源项目来说,测试的代码相对比较简单,大约有1/3的精力都花费在写代码comment,以及代码的文档上了。


因为文档更新其实是工作量很大的事情,所以我们常常会看到有的功能更新比较快的代码库,文档的更新不太及时,并没有解释所有的代码中已经实现的功能。


一般的开源代码库,会有两个主要的的Git的分支。master分支用来提供当前已经稳定的代码版本,以便大部分的用户使用。development分支则用于当前的开发工作,上面的代码可能每天都会有更新,因此不少功能可能不太稳定,对应的文档也可能还没有更新。


每隔一段时间,比如1-3个月,代码库可能会有一次大的发布(release),在把development分支上面所有的功能全部测试,文档全部更新完全以后,用development来代替master分支。至于master上面的旧代码,就会放入一个历史分支中备用。


开源代码库一般也可以允许感兴趣的开发者对这个代码库做出自己的贡献。一般的流程是这样的,社区中的第三方开发者复制了代码以后,做了一些修改,如果觉得自己的修改是对当前代码库的一种提升或者纠错,则可以把这个修改提交给这个代码库,要求加入该修改。这个请求一般叫做pull request。在pull request上面可以看到开发者具体做了些什么样的修改。核心开发者在审阅了pull request的内容以后,可能会在提出修改意见修改以后把pull request的修改合并入development分支,也可能直接拒绝改修改。


在开源代码库的开发者团队内工作,当项目还在快速演进中时,第三方的开发者的修改很难被融入当前项目中。这一方面是因为快速演进的代码库一般文档只有在发布时才会变完善,因而让人比较难以理解当前的开发进度。另一方面是因为第三方开发者的修改很有可能已经在开发者团队的计划之中了,他们的修改提议很可能会被一个更加底层的修改所取代。


当然随着开源代码库的逐渐成熟,必然会有一些并非核心,但是有也很不错的功能,暂时核心开发者团队还没有时间开发。如果说核心开发者能把这些需求列出来,然后作为project挂在代码库上让第三方开发者贡献,那么将会让第三方开发者的贡献变得容易很多。


另外一方面,开源代码库本身也需要一些指导性的文档,来说明几个事情。 一是贡献的代码需要符合怎么样的代码风格,什么样的变量要用什么样的格式来标注,命名。二是什么样的代码可以接受,什么样的代码不会被接受。因为有些代码可能跟代码库的目标以及功能不吻合,将会打乱代码库的结构,不适合被合并入当前代码库中。 


总之,一个成功的开源项目需要大量精心的维护,才可能最终成为一个成功的项目。这个过程中一方面需要项目足够有价值,使得有大量的第三方开发者愿意使用该项目,为该项目提出改进意见。另一方面也需要核心团队带领项目走向一个好的大方向,使得项目始终易于使用,易于拓展,清晰易懂。