前几天有个朋友问我:自己有一个idea不错的项目,也把基本的框架写好了,想贡献到Openstack社区,却不知道应该怎么做。正好之前我有过类似的经历,那么来分享一下我是如何向Openstack社区提交一个新项目。

Openstack的整套系统就是一个开源项目的“大杂烩”,社区把所有项目划分为两类:核心和孵化。除非出身特别牛逼或者从其他核心项目独立出来的项目会在设计之初就被列为核心项目(例如Nuetron,Ironic等);其他项目一般划分到孵化类,在通过一个或多个大版本的发展后,如果变得成熟满足预期并被社区接受,就会转正成为核心项目(例如Savana,Designate等)。如果你想查看当前有哪些核心和孵化项目,可以前去github上查看,它们分别托管在github的openstackstackforge两大项目下:每个核心项目几乎都是来自工业界IT巨头们的贡献,例如Swift项目来自于Rackspace,Nova项目来自于NASA,Horizon项目来自于HP…

简单介绍一下我提交的新项目的来历:由于我们的IaaS服务跨越多个Region,并且有较为复杂的DNS解析需求,因此我们很早就使用了当时仍在孵化中的designate项目(DNSaaS),用于管理UnitedStack内部的DNS服务。我发现社区并没有提供用于管理Designate服务的puppet module,于是就写了一个puppet-designate,随着代码的日益完善,已经可以满足内部designate服务的管理,然而社区却一直没有开发puppet-designate module的计划。公司文化一直支持开源,我也一直活跃在社区中,但以往都是提交某个项目的bugfix或者blueprint,我心想何不尝试提交一个新项目到社区?

前期准备工作

那么在试图说服社区接受自己的项目前,第一步得先规范自己的代码。

不同于个人项目,社区对于代码的规范要求很高。我列出以下几个注意点:

  • 完善的代码文档:例如README,参数说明,每个自定义资源类型或者类的使用举例,复杂逻辑的解释,未来需要重构的加上todo标注等等;
  • 规范的代码格式:首先不能有语法错误,其次是代码风格要和社区一致,这些都有工具来检查,主要问题是在代码风格上,空2格还是空4格,双引还是单引,不是随心所欲的;
  • 合理的代码结构:主类中该放哪些部署逻辑,各服务的组件的部署逻辑该怎么划分,数据库初始化逻辑又该放在哪,都是有要求的;
  • 完善的测试代码:社区项目都是以测试驱动的,有的项目甚至先有的是测试代码,如果你妄图向社区提交一段没有附带测试的代码,其后果就是:红色粗体不解释的-1。

沟通和反馈

大约花了一个周末的时间,终于把上述工作做完了,那接下来要做的就是说服社区:接受puppet-designate项目。 我分析了一下Openstack社区的一个新项目大致可以分为两类:全新和已有项目。例如,Heat,Ceilometer就属于全新项目,先在ML上开个头,开始讨论架构,API的设计等等诸多细节,然后众人分领开发工作,接着开始编码最终实现。而Swfit,Nova就属于旧有项目,从其他公司贡献出来的时候,已经比较成熟或者已经有比较完整的架构了。puppet-designate就属于后者,Openstack社区所有相关的puppet项目归属于puppet-manager-core 组管理,当时的PTL是Puppetlabs的Dan Bode。

第一步,我需要发送一封邮件到社区的邮件列表中来告知参与这个项目的所有成员:我准备提交一个puppet-designate项目来管理designate服务。

这里有一点很重要,就是了解在这个邮件列表中,谁说了算:)。

简单解释一下,每个项目都有一个PTL以及相关的core members,他们是项目的主要贡献者。那么如何查询到具体有哪些人呢?可以在https://review.openstack.org的Groups分类中找到。

于是,我把邮件发送到社区的ML同时抄送给了PTL和其他几位非常活跃的core members。邮件里我说清楚地说明了puppet-designate的目的和完成度,以及附带一个github代码地址,以便review。

鉴于国内和国外的时差,邮件第二天得到了回复,得到了PTL和几位core member的肯定,不出所料的是,我的代码被指出了一堆问题,接下来需要进一步地改进。

由于时差的关系,我与社区的协作效率是不高的,在经过大约一周时间的邮件沟通和多次修改后,代码终于通过了这帮有强迫症的工程师的review。

提交到openstack-intra/config

虽然代码通过了社区的批准,但这并不意味着puppet-designate项目就能立马出现在stackforge中了。接着,我开始阅读社区的CI文档,了解到社区CI系统的管理工作是通过config项目来完成的,Openstack的整套CI系统以及我们所看到的Openstack主站以及其他相关站点都是通过puppet来管理的,该项目就包含了用于管理和配置的modules和manifests,属于openstack-intra组负责。Openstack-intra组的主要工作是负责Openstack站点和CI系统的开发和维护。

因此,我需要向config项目提交一个新patch来添加puppet-designate项目,这个PatchSet看起来是这样的:

首先,修改modules/gerritbot/files/gerritbot_channel_config.yaml文件,这个配置文件用于管理各项目的gerritbot,当发生指定的事件后,IRC上的gerritbot会发送通知:

接着需要修改modules/openstack_project/files/jenkins_job_builder/config/projects.yaml,告知Jenkins在处理来自gerrit的puppet-designate patchset时,需要执行哪些job:

然后还需要修改modules/openstack_project/files/zuul/layout.yaml,告知zuul在做check和gate工作的时候要执行哪些job。:

最后修改modules/openstack_project/templates/review.projects.yaml.erb文件,告知gerrit 新建一个stackforge/puppet-designate的项目,并且去github上拉去初始的puppet-designate代码。

等待Approve

在提交了这个patchset后,我在IRC上去通知PTL和其他成员帮我+1,最后还要得到openstack-intra组core member的approve才行,于是我又去#openstack-intra频道里找人,终于找到一位哥们来帮我Approve。好事多磨,结果最后Gerrit在做merge操作时,Zuul所运行得gate测试报了一些莫名的错误,始终不让这个patchset merge。那哥们说:没事,明天前我会解决的。终于,在HK的Havana Summit前,puppet-designate项目出现在了Openstack社区的孵化项目里:https://github.com/stackforge/puppet-designate

小结

虽然参与Openstack的社区开发已经近三年,但这是我第一次向社区提交一个新项目,通过这次经历,我有以下几点感触:

1. 对于社区的CI系统有了更进一步的了解,因为过去当我输入git review时,整套CI是对我来说是透明的,我根本不知道底层的CI系统各服务之间是如何交互的;

2. 其次是学会和社区沟通,如何清晰地表明自己的观点,如何说服他人,如何找到能拍板的人,若能做好这三点有事半功倍的作用;

3. 最后一点,对于代码的质量要求和规范上有了更深刻的理解,有时候我的同事会不理解我在做code review时为什么会对格式要求那么苛刻,其实我是水瓶座,只是这些习惯是在做社区开发的时候被逼出来的 :)

如何向Openstack社区提交一个新项目的更多相关文章

  1. Vue Create 创建一个新项目 命令行创建和视图创建

    Vue Create 创建一个新项目 命令行创建和视图创建 开始之前 你可以先 >>:cd desktop[将安装目录切换到桌面] >>:vue -V :Vue CLI 3.0 ...

  2. 将本地的一个新项目上传到GitHub上新建的仓库中去

    转载: 如何将本地的一个新项目上传到GitHub上新建的仓库中去 踩过的坑: 1.在git push时报错 error: RPC failed; curl 56 SSL read: error:000 ...

  3. Git库搭建好之后,当要提交一个新的文件,需要做的是3个步骤

    Git库搭建好之后,当要提交一个新的文件,需要做的是3个步骤 1.git add new.txt 2.git commit -m "add a new file" 3.git pu ...

  4. Google C++测试框架系列入门篇:第二章 开始一个新项目

    上一篇:Google C++测试框架系列入门篇:第一章 介绍:为什么使用GTest? 原始链接:Setting up a New Test Project 词汇表 版本号:v_0.1 开始一个新项目 ...

  5. 使用source创建一个新项目(将本地项目文件和github远程库链接)

    1. 本地创建项目文件夹 2. 将本地的项目添加到source中(我使用的source版本为2.4.7.0) 3. github创建远程库  4. 关联本地项目文件和github库 确定添加就可以了. ...

  6. 【Cocos2d-x for WP8 学习整理】(1)创建一个新项目

    喜大普奔                         10.1假期之前看到了一个很振奋的消息,就是随着Cocos2d-x 2.2的发布,WP8/WIN8有史以来第一次的合并到主版本了. 之前 V2 ...

  7. 导入一个新项目需要注意的几大问题(jdk1.6+eclipse4.4+tomcat6)

    今天导项目犯了一个很低级的错误,浪费了半个小时,所以在此罗列出在导一个新的项目到eclipse中时需要注意的几个问题,希望对大家有所帮助. 将项目从svn或者github等项目版本控制软件上拷贝下来, ...

  8. Jersey 2.x 从Maven Archetype 创建一个新项目

    创建 Jersey 工程需要使用 Apache 的 Maven 软件工程和管理工具.所有的Jersey产品模块都可以在 Maven中央库 中找到.这样的话 Jersey 可以非常容易和其他基于 Mav ...

  9. react:如何创建一个新项目

    如何用react创建一个新的项目 我们打开react官网:https://reactjs.org/docs/create-a-new-react-app.html 看到以下命令 npx create- ...

随机推荐

  1. 多媒体技术基础之---Come on!来点儿音乐吧

    其实要说在Linux系统下播放音乐,确实是一件让人非常抓狂的事情,抛开各种音频格式的商业授权不说,即使提供给你相应的解码库,能玩儿得转的人那又是少之又少.可能有些盆友说ubuntu这方面确实做得不错, ...

  2. [[4], [5, 6, 7]](Python)list的方法

    现在我们要学习一些Python的数据结构了,本节将主要学习列表(list)的用法 1.list的方法 list.append(x) 在list的末尾添加一个元素 >>> a=[1,2 ...

  3. 【Java学习笔记】<集合框架>对字符串进行长度排序

    package 测试; import java.util.Comparator; public class ComparatorByLength implements Comparator { //定 ...

  4. Unity多线程(Thread)和主线程(MainThread)交互使用类——Loom工具分享

    Unity多线程(Thread)和主线程(MainThread)交互使用类——Loom工具分享 By D.S.Qiu 尊重他人的劳动,支持原创,转载请注明出处:http.dsqiu.iteye.com ...

  5. 四色定理+dfs(poj 1129)

    题目:Channel Allocation 题意:要求A:BCD,A与B,C,D都不相同,求不同的值,典型的四色定理: #include <iostream> #include <a ...

  6. CodeIgniter 定义“全局变量-global variable”,可以在所有controller,model和view中使用

    本文抄自http://www.cnblogs.com/webu/archive/2012/11/20/2779999.html 第一次正儿八经用CodeIgniter框架做项目,结果不会定义全局变量, ...

  7. Mine Number(搜索,暴力) ACM省赛第三届 G

    Mine Number Time Limit: 1000ms   Memory limit: 65536K  有疑问?点这里^_^ 题目描述 Every one once played the gam ...

  8. C语言extern作用(全局变量)

    用C语言编写程序的时候,我们经常会遇到这样一种情况:希望在头文件中定义一个全局变量,然后包含到两个不同的c文件中,希望这个全局变量能在两个文件中共用. 举例说明:项目文件夹project下有main. ...

  9. HDU1695 GCD(莫比乌斯反演)

    传送门 看了1个多小时,终于懂了一点了 题目大意:给n,m,k.求gcd(x,y) = k(1<=x<=n, 1<=y<=m)的个数 思路:令F(i)表示i|gcd(x,y)的 ...

  10. DateSort选择法、冒泡法排序

    public class DateSort {public static void main(String args[]) {Date d[] = new Date[11];d[0] = new Da ...