Browse Source

docs:新增README文档

Xu·LinPeng 5 months ago
parent
commit
c747e19e14
1 changed files with 34 additions and 0 deletions
  1. 34 0
      README.md

+ 34 - 0
README.md

@@ -0,0 +1,34 @@
+# 清水营数据接口项目
+
+# git 提交规范
+### 1、提交前缀规范(区分类别)
+(1) feat:新增功能或页面;
+(2) delete:删除功能或文件;
+(3) fix:修复bug、解决冲突(尽量避免);
+(4) modify:修改功能;
+(5) docs:修改文档;
+(6) refactor:代码重构,未新增任何功能和修复任何bug;
+(7) build:改变构建流程,新增依赖库、工具等(例如webpack修改);
+(8) style:仅仅修改了空格、缩进、注释等,不改变代码逻辑的变动;
+(9) perf:改善性能和体现的修改;
+(10) chore:非src和test的修改;
+(11) test:测试用例的新增、修改;
+(12) ci:自动化流程配置修改;
+(13) revert:回滚到上一个版本;
+(14) scope:【可选】用于说明commit的影响范围
+(15) subject:commit的简要说明,尽量简短
+
+### 2、提交文字规范
+
+格式:提交前缀:动作行为+问题内容
+
+示例:
+
+(1)feat:新增xx页面
+(2)feat:新增xx页面xx功能
+(3)fix:修复xx页面xx bug
+(4)modify:修改xx页面xx功能
+(5)delete:删除xx页面
+(6)refactor:重构xx页面xx功能
+(7)style:删除多余注释代码/控制台打印代码
+(8)refactor:迁移xx文件到xx目录