OpenBuild官网前端代码库开放!

自今年8月底我开始深度参与OpenBuild贡献以来,我的第一个目标就是将OpenBuild官网的前端代码库开源——这非常符合OpenBuild的性质和发展轨迹。

刚接手这个项目的时候,看了一下代码,感觉比较乱,为了达到目的,有两个关键点需要解决:

  • 调整文件组织方式及引用方式,增加约束,保证多人协作时的可维护性。
  • 撰写各类协作文档,补充开源所需的其他材料。
  • 以我去泰国参加 Devcon 的行程作为时间分割点,我在这个时间点的前后重点关注了上述两个方面。

    尽管我还没有达到完美,哪怕只有80%,但我相信这并不妨碍我现在在这里兴奋地宣布:

    **OpenBuild官网前端代码库开源啦!**

    介绍

    在OpenBuild官网,开发者可以:

  • 免费学习Web3技术和专业知识;
  • 参加黑客马拉松、聚会和其他线下活动;
  • 领取赏金;
  • 建立个人领域影响力;
  • ...
  • 虽然它被称为OpenBuild官方网站,但是不要被官方网站这个词吓到,因为它是一个Web应用程序,而不是静态网站。

    此外,它不是传统的 Web 应用程序,因为某些功能与智能合约交互,使其成为去中心化的应用程序,又名 dApp。

    作为一个 Web3 开发者社区的官网,代码库中采用的技术栈自然是领域内常规的基于 React、Tailwind CSS、Next.js 的一套。

    有经验的人就会知道,这样的项目如果没有良好的治理手段,代码很容易陷入混乱的状态。

    在我介入之后,利用多年积累的经验和思考所形成的反混沌理论与实践体系,我已经显著地降低了熵值:

    The module relationship of the modularized directory structure division

    主要通过调整文件的组织方式和引用方式,以及增加约束条件,呈现出如上图所示的架构层次。

    为何开源?

    正如开篇所说,将OpenBuild官网的前端代码库开源,是符合OpenBuild的本质和发展轨迹的,因为OpenBuild是一个开源社区:

    一个连接 Web2 和 Web3 的开源社区,连接建设者和企业,并赋能他们获得成功!

    ——

    作为开源社区,开源自己的代码库是理所当然的事情,在此基础上,也践行开源精神,帮助参与者在(包括但不限于)以下几个方面得到提升或受益:

  • 具有少量前端开发经验的人也能理解现代前端开发是什么样的。
  • 具有一些前端工程经验的人可以了解如何管理和维护复杂的前端应用程序。
  • 为国内前端开发者提供与国外主流技术栈实践的机会。
  • 熟悉并适应基于GitHub的远程异步协作。
  • 体验开源项目的运作方式。
  • 创建您自己的 WhateverBuild。
  • 当然开源对于OpenBuild本身也是有好处的,比如:让开发者参与共建,这样才能真正满足开发者和社区的需求,让开发者越来越喜欢用、爱用,而OpenBuild官网可以说是一个面向开发者的产品。

    事实上,OpenBuild 早就想将代码库开源,但早期开发团队希望等待完整的产品再开源。

    但是产品出来之后却发现,在诸多迫切需求(OpenBuild发展迅速)之下,很多不合理的架构设计和混乱的代码被迫浮现出来,而且即便开源,也不是所有人都可以参与的。

    所以最近花了很多时间优化架构和代码,同时完善贡献文档和流程,导致延迟。

    另外我猜还有一个原因——等待好的人的出现(请允许我稍微夸一下😆)。

    如何参与共建?

    如果你有兴趣参与共建,OpenBuild欢迎你的加入!

    理论上,对参与共建的人没有什么硬性要求,但是为了尽可能高效地协作,最好是事先已经学习并掌握了一些相关的知识和技能。

    阅读完《如何参与项目共建》后,可以按照以下大致步骤进行共建:

  • 阅读项目相关文档。
  • 前往特定的 GitHub 项目来挑选适合您的任务。
  • 在项目存储库中 Fork 指定分支。
  • 在本地开发任务代码。
  • 发起 PR 并将任务标记为已完成。
  • 除了通过完成任务来贡献代码之外,您还可以通过提交问题、缺陷或改进建议来共同构建。

    未来OpenBuild还会根据项目共建者的一些指标,发放相应的成果和福利。

    结论

    无论对我自己还是对 OpenBuild 来说,开源都是一种理想、一种激情、一种使命!

    因为这样,我们散发着同样的味道,相遇相识,共同前行!