2. 立项
凡是项目都需要创意,或者我们称之为“点子”,来源有多个方面。
很多开源项目包括编程语言都诞生于解决特定问题的过程中,比如Java诞生于智能硬件平台的研发过程中。所以你日常遇到的一些问题和你对这些问题的解决方案可以成为你创建开源项目的一个思路。这种情况下需要更多的创造性,同时还要规避一些法律风险。
你也可以对其它一些开源项目进行扩展和优化,有时候我们可以站在巨人的肩膀上。就像开源Git托管平台Gitea诞生于Gogs。
更简单的方式是你甚至可以整合脚手架,目前在Github上的整合脚手架非常多,甚至有些项目知名度还非常高。
当你有这个契机你就有孵化开源项目的先决条件了。
3. 开发
接下来就是开发了,最开始只有你自己贡献全部的代码,而且你可能需要做得更多。开发尽量遵循Git工作流,ISSUE功能要充分利用起来,用户的咨询建议和BUG反馈尽量通过ISSUE来处理。
通过吸收 Pull Request 也可以集思广益,提升你项目的质量。Gitee和Github还提供了一些漏洞检测和质量检测功能。也能提高你的开发质量。
3.1 测试
作为开源项目,一定要把好质量关。起码的单元测试要做,这样其它开发者会更加信任你的项目。
3.2 开源协议
开源协议是开源项目的重要标识,这个是必须的步骤。目前开源协议有很多,选择一款适合你的,一般情况下我选择 Apache 2.0 。
协议除了放一个 LICENSE 文件在项目的目录中外,最好在每一个源代码文件的 copyright 头中也声明一下,比如胖哥的开源项目 Payment Spring Boot 中是这样的:
3.3 其它配套设施
作为一个开源项目,项目说明 README.md 要有,用来对项目进行简单的介绍。因为是源码开放,代码注释也非常重要,也有利于向别人讲解你的思路和意图。如果有精力构建一个项目主页就可以让你的项目更加高大上了,把文档、图文教程、CHANGELOG、Q&A、RoadMap分门别类放进去,也有利于用户更加深入的了解学习你的开源项目。你可以看胖哥以往的相关文章有介绍的哦。
4. 发布
如果觉得你的项目已经达到可用的程度就可以公开发布了。源代码国外肯定是放在Github上,国内选择Gitee(码云)。根据你的喜好选择一个主库,两者定期同步。另外要明确开发分支和正式分支,最好默认显示最近的正式版本分支。
大致的发版步骤
版本一经发布不能进行更改,版本号建议语义化,参考下图中Gitee的语义化说明。
Github和Gitee都提供了创建发行版的功能,以Gitee为例(Github同样有类似的功能):
创建完毕后,你的项目就会生成一个发行版,用户可以通过对应版本的发行版获取对应版本的源代码,查看描述。
在进行源代码发行的同时,也建议部署对应的编译版本到公用依赖库,比如Java项目会发布的Maven中央仓库,JavaScript项目会发布到NPM,Python项目PyPi。如果你有能力使用CI/CD的话(例如Github Action),可以让整个发版流水线化。
记得发版的同时,要发布对应版本的更新信息、文档等配套设施。
5. 推广
只要是产品就需要推广。推广是一个技术活,而这往往不是技术人员的强项。你可以在目标人群的聚集地友好地宣讲你的开源项目,例如一些开发者社区(开源中国),交流群等等,甚至是这几年比较火的短视频。每次发版可通过一些公共渠道进行公告。让你的开源项目尽可能为人所知。但是请不要作弊,不要学某些人走捷径,花钱去购买Star。
在推广的过程中,要学会收集和分析用户的意见。
6. 社区驱动
推广的同时要进行社区建设,有利于拉升你开源项目的活跃度,同时也可以从中提炼项目的需求。甚至可以将社区活跃者提升为项目贡献者,组建一个开源小团队。
社区驱动是开源项目发展的重要动力。
7. 总结
如果你想做好开源,就要把开源项目当做产品来做,坚持、创新、协作、运营、服务一个都不能少。个人也会在项目的打磨中成长提升。对于开源更重要的是一种态度。无论项目涉及的技术是否高深,开源者都应该得到鼓励和尊重。