前端开发的一些规范

多人开发

1，目录杂乱无章

2，代码风格不统一

3，接口传参不同意 比如有人post接口按照get接口传参

4，错误码格式不统一 有字符串 有 数字

有哪些规范，是否涉及代码分为两类

1，非编码类规范

技术选型规范

首先技术选型需要列出至少3种以上的方案，方案的各有有点缺陷，为什么最中选这个方案，开源方案是否支持商用等

前端概述规范

需要说明对需求的理解，对复杂代码的讲述，为什么要这么做等问题

文档规范

readme文档

其他开发者了解项目时候会阅读的第一个文档，该文档在根目录下面，

redme文档包含以下

1，项目介绍，

例如：需要什么版本的Npm和 node 怎么构建，运行等问题

2, 使用者指南

描述如何使用项目

3，待办清单，后续的计划等

变更记录

那个版本优化了哪些BUG，升级引来的变化，变更时间，具体变更内容

API文档 一般写在 rendme中

commit规范

首先有三条：header (类型比如说BUG 修改 新增,主题)

body 本次开发的内容的详细描述

footer 一些不兼容的变更 用的比较少

版本规范

v1.2.3

主： 做了不兼容的API时候底层

次: 做了新增功能，比如版本发布时候

修定号： 次版本修复的问题

2，编码类规范

代码规范：参考airbnb谷歌规范，eslint代码质量检查工具 prettier格式化规范统一

接口规范: 有一部分传参时候会出现哪种 post请求get传参方式，需要统一

目录规范：给出一个常见的目录实例，包的目录，库的目录