前端规范文档

基于前端研发全流程建设的 SOP

规范的目的:

  • 通过一致性来减少协作和沟通
  • 通过标准化来规避问题和错误
  • 通过最佳实践来奠定自动化基础

约定:

  • 规范不是为了满足个人的习惯,而是为了团队更好的进行协作
  • 准备引入框架新写法或者新技术时,引入之前必须第一时间联系规范维护人,配合一起同步到全组进行评估。对与较大的新技术或者新写法引入(例如 react hooks,typescript 这种),需要先组成学习小组,总结实践,然后申请进行试点,再逐步推广,不把工程项目当成新技术的试验田
  • 规范并不一定是最佳实践,应该以稳定和高效为原则

一、代码风格

JS 规范

React 规范

命名规范

二、开发规范

通用规范

业务通用参数

接口规范

交互规范

Git 规范

埋点规范

日志规范

报错收敛规范

性能规范

  • 压力测试规范
  • 性能评分规范

安全规范

  • CSRF 攻击
  • XSS 攻击
  • 横向越权
  • 纵向越权

单测规范

自动化测试规范

三、流程规范

技术方案规范

Code Review 规范

灰度规范