DevUI 开源经验:从启动开源项目到运营开源社区

据 Github 官方统计,从2016年开端,Github 渠道每年平均新增1000多万开发者、5000多万开源项目,且增幅出现逐年递加的趋势。而我国的开发者参加开源的热情更是超过其他国家,不管是开发者仍是开源项目的增长速度,我国都是独占鳌头,2021年我国共有755万 GitHub 开发者,全球排名第二。

我国在“十四五”规划中首次把开源归入顶层规划, 从国家层面体现了对开源的注重,国内的华为、腾讯、阿里等多家大厂也都将开源作为公司战略的一部分,国内外开源出现一片昌盛的景象,开源的春天现已来了!

发动开源项目

开源生态是以开源项目为中心、以奉献者组成的开源社区为要害要素构建的,作为一名个人开发者,咱们要怎么发动自己的开源项目,为整个开源生态作奉献呢?

项目价值

一个好的开源项目应该是能够满意人们的某种需求或者解决人们的某个痛点的,也便是说它应该是有价值的。在发动一个开源项目之前,咱们需求想清楚开源项目的用户集体是谁,能满意他们的什么需求,解决他们的什么问题,把价值讲清楚了,就能够发动开源项目啦。

比方 Vite 这款前端构建东西,面向的用户集体是广大的前端开发者,解决了 Webpack 构建速度缓慢的问题,为前端开发者供给极速的服务发动和轻量快速的热重载体会,赢得了开发者的青睐。

代码库房

发动开源项目首先需求有一个主意,然后便是经过代码实现这个主意,所以需求创立一个代码库房。

比方 Vue DevUI 是一个基于 DevUI Design 规划体系的前端组件库项目,运用 Vite + Vue3 + TSX 技能搭建,咱们就需求创立一个 Vite + Vue3 + TypeScript 的前端项目工程,推送到 Github 代码库房,这便是开源项目的起点啦。

有了代码库房仅仅一个起点,作为项目的开创人,你还需求将你的主意最核心的那部分经过代码实现,构成项目的骨架,进而招引社区开发者一同把项目的其余部分完善起来。

以 Vue DevUI 前端组件库为例,咱们需求有一个组件目录,用来寄存一个个的组件,而且需求开发一部分规划良好的组件,以供后来的奉献者参阅。

咱们还需求搭建一个文档体系,用来展现组件的 Demo 作用和 API 文档,需求能经过一个简单的 npm run dev 命令本地发动这个文档体系,方便开发者进行组件功用的调试。

组件库最终是要发布到 npm 库房给开发者运用的,因而还需求开发组件库的构建脚本,打通从本地开发到构建发布的流程。

完成这些工作,项目的骨架就构成了,这为以后的社区协作供给了根底。

配套文档

项目骨架仅仅供给了社区协作的根底,但要招引开发者参加社区,让协作更加高效,还需求完善一些必要的文档。

首先便是一份精心编写的 README 文档,一般包括以下几个部分:

  • 项目名称和LOGO
  • 项目简介和特性
  • 快速开端文档
  • 奉献者
  • 开源许可

README 一般是给项目的运用者看的,还有两份文档是给参加项目奉献的开发者看的,也非常重要,一份是社区行为准则,要点阐述你期望社区成员应该遵循的行为是什么,你对立什么样的行为,这关于营建活跃友爱的社区气氛非常重要;另一份是奉献者攻略,这为初度参加项目奉献的开发者供给了一份具体的入门指导。

Vue DevUI 的奉献攻略具体描述了参加奉献的步骤,怎么 Fork 和 Clone 项目代码,怎么本地发动项目和调试代码,编码标准是什么,怎么提交代码和建议PR等。之所以写得这么事无巨细,是因为咱们发现很多开发者是第一次参加开源奉献,为了让他们能比较顺利地参加进来,除了编写具体的奉献攻略,咱们还专门录制了一期教育视频,手把手教咱们为开源项目提交第一个PR。

此外,为了保证项目质量,保证代码风格坚持一致,还需求供给一些开发标准文档,这些标准有一部分是能够经过自动化东西来查看的,还有一部分需求经过文档的方法来展现。

比方代码提交标准能够经过 commitlint 东西来进行束缚,编码标准能够经过 ESLint 东西来查看,文件命名标准能够经过 ls-lint 来进行束缚等。

而组件文件怎么安排,组件怎么编写,组件的 demo 和 api 文档格局是怎样的,这些很难经过东西来束缚,就需求咱们经过文档的方法供给,并经过代码检视辨认未遵循标准的代码,引导开发者一同遵循标准,编写出高质量和强一致的代码,最大程度保证项目质量。

运营开源社区

有了代码库房和配套文档,咱们就能够在技能社区建议开发者招募啦,只需有了开发者参加进来一同建造项目,成员之间不断互动和交流,开源项目就慢慢变成了开源社区。

人们会因为你的宣扬而参加到开源社区中来,但真实让他们留下来的,必定是社区能给他们带来价值,让他们发生成就感和归属感,这也便是开源社区运营需求要点重视的。

社区价值

开源社区包括对社区成员和安排的两层价值,要招引更多人参加社区,需求讲清楚社区存在的价值。

社区成员渴望有意义的协作方法,经过社区,他们能够:

  • 结识其他优秀的人
  • 丰厚人生体会
  • 高质量的学习资源、彼此交流和寻求协助的渠道
  • 培养技能
  • 取得指引和辅导
  • 堆集职业经验和专业知识,丰厚简历

安排期望取得商业成功,而经过社区,安排能够:

  • 实现用户的增长
  • 供给更好的支撑
  • 提高品牌认可度
  • 产品和技能晋级
  • 招引人才和招聘

这种双赢是开源社区能够继续发展的根底。

参加模型与鼓动方案

每一位对社区感兴趣的开发者都会经历新手阶段,新手体会的好坏决议他会不会继续留在社区,成为奉献者,再到维护者、办理者。

为了鼓动不同阶段的奉献者,提高奉献者的参加度,坚持社区的长时间健康发展,需求拟定一套奉献者点评标准和鼓动方案。

社区成员能够依照对社区的奉献程度分成:

  • 入门者:有志愿参加社区,但还未做出实际奉献的开发者
  • 奉献者:提交第一个PR并合入的开发者即可成为奉献者
  • 维护者:在社区长时间活泼、做出重大奉献的优秀奉献者,即可由办理者选拔为维护者
  • 办理者:具有必定的安排和领导才能,能带领社区变得更好,由现有办理者进行投票选拔

每次达到一个新阶段就即时鼓动,一方面是鼓动以往的奉献,另一方面也是鼓动后续继续的奉献,一个阶段连接另一个阶段,从而提高各阶段奉献者的参加度,让社区不断发展和昌盛。

比方只需有开发者提交一个PR并被合入,就给他发一封感谢邮件,恭喜他成为奉献者,将他参加奉献者列表,并邀请他参加微信群和邮件列表,这会让新手感到自己在社区作出的奉献是被认可的,从而遭到鼓动。在检视第一次参加社区奉献的开发者的代码时,也需求分外用心,关于做得好的地方要不吝惜给予赞美,做得缺乏的地方耐心给予指导,让开发者感遭到自己是受欢迎的,这关于新手来说是非常重要的。

现已参加社区并参加过屡次奉献的社区成员,咱们能够考虑选拔为维护者,给他邮寄一些小礼物或颁布荣誉证书,感谢他在社区作出的杰出奉献,并适当在公开场合表扬。这部分社区成员由于现已走过了新手期,对项目和标准都很熟悉,是社区非常重要的组成部分,必定要争取让他们留下来,与他们坚持密切的交流,长于发现他们的志向,协助他们取得成功,未来他们中的一部分很可能成为社区办理者,成为影响社区发展的要害。

开创人和办理团队

关于长时间活泼,作出巨大奉献,而且表现出必定安排和领导才能的维护者,应该考虑选拔成为办理者,办理者是从社区中精挑细选出来的奉献最大的社区成员,他们是你最值得依赖的合作伙伴,也是社区的核心所在,他们决议了社区未来的走向。

而开源社区开创人最要害的职责将办理团队成员凝集在一同,朝着一同的方针行进。

关于开创人来说,最重要的是坚决的信仰,尽管开源的路途漫漫,但作为项目开创人要坚持坚决的推进社区和项目继续往前的信仰,对外活跃宣扬自己的开源社区和开源项目,招引有志之士参加,对内鼓动社区成员的士气,凝集人心,朝着一同的方针不断行进。

没有锲而不舍的精力和坚决的信仰,社区文化很难构成,社区成员的凝集力和归属感也很难构成,社区也就很难长久发展和继续昌盛。

另外便是需求具有必定的安排才能,运营开源社区和办理开源项目都是非常复杂的工作,需求规划好久远的方针,并将方针拆解成要害事项,分解到社区成员。需求安排好人和事,需求具有良好的与人交流和协调的才能,经过有条不紊的项目办理和规划,保证社区和项目的健康发展。为了让开源项目发生更广泛的影响力,开创人还需求具有必定的写作和演讲才能,对外宣扬和推广开源项目。

开创人既要一直瞄准行进的方向,又要兢兢业业重视项目的质量和发展,重视社区的健康,重视行业和技能发展趋势,坚持与社区成员的联络。

DevUI 开源社区每周都会安排线上 PMC 会议,和办理团队成员一同评论 DevUI 开源项目未来的规划,要害事项的发展情况,竞争力建造,社区生态扩展等事务,为了更顺利的协作,一同拟定流程和标准。每位社区成员都能够申报议题,咱们在 PMC 会议上评论和决策。

每周咱们也会安排面向更广泛开发者的田主大会,带咱们一同检视代码、评论组件的规划和实现、分享新技能等,一方面将咱们的经验和理念传递给社区开发者,提高参加社区的体会,另一方面咱们期望能供给一个社区成员之间更紧密的交流渠道,后续咱们也会尝试将线上的交流会迁移到线下,让咱们能有更多的交流和彼此碰撞的机会。

社区是由人组成的,社区的昌盛依赖于社区成员的奉献、参加和协作,只要将社区成员凝集在一同,集思广益,才能创造出更好的开源项目,这也是开源社区运营的核心所在。

欢迎咱们参加咱们的开源社区,增加小帮手微信:opentiny,重视咱们的开源项目:github.com/DevCloudFE

也欢迎了解咱们的开源故事:

  • DevUI 开源的故事
  • 建造一个温暖的开源社区
  • DevUI开源:种子终会破土而出!