little-bee-client

Why

为了让大家更快地了解“蜂乐场”，也为了更好地维护“蜂乐场”项目。本文罗列了“蜂乐场”游玩规则，即“蜂乐场”项目在开发和维护中遵循的一些准则。

为什么要制定“蜂乐场”游玩规则？

• 避免出现Tech Debt

  代码不是一种资产，而是一种债务。

  所谓Tech Debt就是遗留在项目中的一段不简洁（甚至是丑陋）的代码片段。每位程序员都不想遇到这样的代码片段，因为遗留代码总是存在各种各样的坑。但是一个多人项目开发下来，Tech Debt数量常常只增不减。为了防止出现代码的“破窗效应”, 规定一些大家都遵守的准则是百利而无一害的。

• 帮助开发者创作

  编码世界中会不断涌现各种编程模式（Pattern）以帮助开发者编写他们的程序。这些编程模式，是前人在开发实践中的经验总结。而后来者只要遵循这些模式就能避开开发后期的很多坑。编程模式就是一种规则。例如，Flux架构、订阅者模式等。

• 提高“蜂乐场”的可读性

  代码不是给自己看的，是给别人看的。

  编写代码和撰写文章是类似的。评判一段代码的好坏，不是应是它实现了什么功能，而是看它是否易于理解。一篇结构混乱的文章，会让读者抓狂。一段丑陋的代码，不仅让后来者头疼，更埋下了出现Bug的隐患，

规则的好处很多，但是凡事物极必反。过于繁冗的规则，会限制创作者的自由，增加创作者的负担。因此，“蜂乐场”不会制定过于细碎的规则，以保证项目的自由度。

What

“蜂乐场”规定了什么游玩规则？

-“蜂博客”结构规则 - 在“蜂乐场”的博文统称为“蜂博客”，博客文章需遵循Why? What? How?三段式结构。详情可参考“蜂博客”：如何写一篇“蜂博客”

• 前端编码规则
  • 前端编码需选择TypeScript而不是JavaScript，通过类型检查尽早暴露问题。详情可参考“蜂博客”：如何在Gatsby中使用TypeScript
  • 前端代码提交需要通过ESlint检测，以遵循编码最佳实践。详情可参考“蜂博客”：如何在VS Code中用ESlint规范代码
  • 利用Jest对前端代码进行单元测试。详情可参考“蜂博客”：如何在Gatsby中进行单元测试
• 后端编码规则
  • 遵循MVC架构，分离控制逻辑和数据处理
  • 利用接口进行解耦合，实现组件模块化。详情可参考“蜂博客”：“蜂工厂”简介

How

如何在“蜂乐场”中游玩？

“蜂乐场”是一个开源项目。而开源项目最大的乐趣就是可以让大家一起参与进来。

• 如果您需要构建一个静态展示网站，例如，一个博客系统，可以利用“蜂工地”中的资源，以掌握“Gatsby”框架。
• 如果您需要构建一个REST风格的动态网站，例如，一个监控平台，可以利用“蜂监工”中的资源，以掌握“Ant Design Pro”框架。
• 如果您需要搭建一个高性能服务器，可以利用“蜂工厂”中的资源，以掌握“Gin”框架。