开发规范

Standards for development team.

作者：Zero

授权：保持署名—非商用许可证

目录

• 公约

  • 技术选型公约

• 开发流程

  • 技术需求撰写规范

• 代码仓库规范

  • Gitlab 使用规范
  • Git 版本管理规范
  • Git 提交信息规范

• 代码规范化

  • 基础语言规范

    • HTML规范
    • CSS 规范
    • CSS-BEM 规范
    • JavaScript 规范
    • TypeScript 规范
    • Node.js 规范
    • Java 规范

  • 预编译器规范

    • Pug 规范
    • Stylus 规范

  • 框架语言规范

    • HTML-Vue规范
    • Vue 规范
    • Egg.js 规范
    • Nest.js 规范

  • 代码编写规范

    • 代码注释规范
    • 代码检测规范
    • 编辑器使用推荐-VSCode

• 框架规范化

  • 项目目录结构规范

    • Vue 框架规范（HTML-Vue、Vue目录结构、template模板）
    • Nuxt 框架规范（Nuxt目录结构、template模板）
    • mpvue 框架规范（mpvue目录结构、template模板）
    • Cordova 框架规范（Cordova目录结构、template模板）
    • Flutter 框架规范（Flutter目录结构、template模板）
    • Nest.js 框架规范（Nest目录结构、template模板）
    • SpringBoot 框架规范（SpringBoot目录结构、template模板）
    • 脚手架规范（命令行、可视化）
    • 组件/插件/中间件开发模板(js-plugin/Vue-component)

  • 脚手架

    • 命令行
    • 可视化

  • 框架模板

    • web：Vue-template
    • web：Nuxt-template
    • 小程序：mpvue-template
    • hybird：Cordova-template
    • native：Flutter-template
    • node：Egg-template
    • node：Nest-template

  • 组件/插件/中间件开发模板

    • js-plugin-template
    • Vue-component-template

• 组件规范化

  • NPM 包管理规范
  • NPM 私服使用规范
  • JavaScript 插件：JS 工具函数 / Fetch / Cordova-plugins / 短信发送
  • Vue 插件：过滤器 / 转场动画 / 路由生成
  • Vue H5 组件库
  • Vue 中后台组件库
  • mpvue 组件库
  • Cordova 组件库
  • Flutter 组件库
  • Egg.js 中间件
  • Nest 中间件

• 数据结构规范化

  • JavaScript 数据结构规范
  • REATful API 规范
  • 数据存储规范
  • 数据流转规范
  • 数据库设计规范

• 测试规范化

  • 数据模拟：前端框架内部mock集成
  • 接口展示、模拟与测试平台Yapi
  • 应用错误监控与报警
  • 单元测试 待扩充
  • 集成测试 待扩充

• 集成发布规范化

  • 开发流程规范
  • 构建与发布规范
  • 发布流程规范
  • Jira项目发布任务信息说明
  • CDN建设与非覆盖式发布
  • 本地Docker构建统一环境

版权许可

本书采用“保持署名—非商用”创意共享4.0许可证。

只要保持原作者署名和非商用，您可以自由地阅读、分享、修改本书。

详细的法律条文请参见创意共享网站。