前端项目开发规范

151 阅读2分钟

本文主要通过自身在字节项目开发经历结合Arco-cli脚手架创建的项目编辑

项目为什么需要一套严谨的规范?在这个人员变动频繁的时代,每一位新开发人员接手别人的项目时都会有一段熟悉适应期,这段时间的长短取决于项目的复杂程度,合理的规范能够让新人快速上手适应。规范自我的同时也是对自己的帮助,毕竟,你也不希望去接受屎山吧。

项目分支命名(按需选取)

  • 线上生产环境: master
  • 线上测试环境: release
  • 开发测试环境: develop

项目开发流程

前情提要》正规开发团队一般存在岗位如下 非研发人员:cPM(项目负责人)、运维、产品测试QA 研发人员:项目组长(项目负责人)、前后端研发工程师(人员比例一般1:[2.5-3])

  1. 产品功能需求设计

一般正规的项目产品在为其修改或添加新功能时,为保留记录,一般都会有个产品经理编辑的需求设计方案文档。

  1. 产品功能需求评审

需求设计文档编写后,需要跟研发人员沟通交流,目的为方案的合理性和实现成本做考虑比较。目的是确定研发时间和部署上线时间。

  1. 产品功能技术方案设计

沟通是为开发效率的提升,前后端开发前必须沟通确定分工明确,以文档记录为准,编辑记录数据变化,接口参数类型

  1. 部署测试环境测试

测试时为了保证产品的质量,一切以客户满意为准。

  1. 部署生产环境上线

只有通过了测试的功能才可以部署上线。

项目开发规范

重点来啦

  • 分支规范

    • 新功能开发ft_

    每当开发新的功能,都是从develop分支切出一个新的开发分支git checkout -b 新分支名称。新分支名称如果又有功能性分类也有质量提升,例如新功能以ft_开头。

    • 老页面修复fix_ 原有界面的功能修改或bug(这里指隐性遗留问题,触发可能性低)修复,可以等下次部署上线带上。
    • 线上紧急修复hotfix_ 线上系统报错,需要紧急修复。从master线上分支切取,然后修改好之后合并入mater和develop两个分支。
  • 文件规范

    以下图为准

    1712028018743.jpg

  • 命名规范【自定义:一般要求通俗易懂即可】

    • 文件名规范

    • 变量名规范