开发规范化

根本目的就是为了保证团队成员的一致性,从而减少沟通成本,提高开发效率。

代码规范

  1. 编写易于阅读、可维护的代码。
  2. 规范的代码可以促进团队合作
  3. 规范的代码可以降低维护成本
  4. 规范的代码有助于 code review(代码审查)
  5. 养成代码规范的习惯,有助于程序员自身的成长

制订代码规范

代码规范一般包含了代码格式规范、变量和函数命名规范、文档注释规范等等。

检查代码规范

  1. 使用工具校验代码格式。
  2. 利用 code review 审查变量命名、注释。

git 规范

分支管理规范和 git commit 规范。

分支规范

  1. 开发新功能:开发新功能时,需要从 dev 上拉一个 feature-功能名称-开发姓名 分支进行开发
  2. 修改 bug:需要从有 bug 的分支(环境)上拉一个 bug-功能名称-开发姓名 分支进行修复
  3. 合并分支:在将一个分支合并到另一个分支时(例如将 feature-* 合并到 dev),需要查看自己的新分支中有没有多个重复提交或意义不明的 commit。如果有,则需要对它们进行合并(git rebase)。
  4. 部署:当 dev 分支通过测试后,就可以合并到 master 进行发布了。

git commit 规范

git 在每次提交时,都需要填写 commit message。

验证 git commit 规范

利用 git hook 能在特定的重要动作发生时触发自定义脚本。

验证 git commit 规范也不例外,我们需要通过 git 的 pre-commit 钩子函数来进行。当然,你还需要下载一个辅助插件 husky 来帮助你进行验证。

项目规范

项目规范主要是指项目文件的组织方式和命名方式。统一项目规范是为了方便管理与修改,不会出现同样性质的文件出现在不同的地方。

文件、目录命名的统一

UI 规范

UI 规范是指项目里常用 UI 组件的表现方式以及组件的命名方式,而不是指 UI 组件如何设计。

制定 UI 规范的好处:

  1. 统一页面 UI 标准,节省 UI 设计时间。
  2. 减少沟通成本,提高前端开发效率。