Merge branch 'master' of http://182.92.126.35:3000/hrx/mky-vent-base

.github/COMMIT_TEMPLATE

@@ -0,0 +1,22 @@
+# 从下列关键词中选取一项
+# Feat 添加新功能、开发新页面
+# Fix 修复功能、样式问题
+# Mod 页面已有功能修改
+# Style 调整页面样式、代码格式
+# Perf 项目性能优化
+# Refactor 项目重构，模块重构
+# Revert 撤销已同步到远程仓库的提交
+# Test 单元测试
+# Docs 项目文档添加、更新
+# Chore 项目架构开发、更新
+# Workflow 项目工作流开发、更新
+# CI 项目自动集成流程开发、更新
+# Wip 暂未完成的工作
+# Types 类型补充
+# 提交信息应如`[Feat 0000(即禅道任务ID，暂无就用0000)] xxxx(即禅道任务名称，暂无可自己编写)`
+# 下面是几个例子，最好能写成一行，方便changelog归档：
+# [Feat 1234] 元宝湾-开发风门页面
+# [Feat 4321] 元宝湾-风门模块api对接
+# [Fix 0000] 宝平湾-首页传感器数据显示不正确
+# [Mod 0000] 袁大滩-风门传感器列表去掉风速一列
+[Feat 0000] xxxx

README.md

@@ -1,2 +1,37 @@
-# VentAnaly_2.0_front
+## VentAnaly_2.0_front
+
 系统v2.0前端代码仓库
+
+### 前言
+
+本项目以[jeecgboot](https://github.com/jeecgboot/jeecgboot-vue3)为模板，请先阅读此文档后继续！
+
+### 开始
+
+建议：安装 nvm 或其他 nodejs 版本管理器，使用 VSCode 作为 IDE，使用 Chrome/Edge 浏览器；
+
+1. 在项目目录下执行 `pnpm install`
+
+2. 在项目目录下执行 `git config commit.template .github/COMMIT_TEMPLATE`
+
+### 开发
+
+开发的基本流程，部分内容可忽略
+
+`git pull` # 可以rebase
+
+`git checkout [branch]` # 可选
+
+`nvm use 20` # 建议，高版本node自带pnpm包管理器
+
+`pnpm dev` # 必选，dddd
+
+`git add .`
+
+`git commit` # 公用模板见.github/COMMIT_TEMPLATE
+
+`git push origin [branch]` # 目前master分支无保护，可直接推
+
+### 构建
+
+`pnpm build`

commitlint.config.js

@@ -10,23 +10,7 @@ module.exports = {
     'type-enum': [
       2,
       'always',
-      [
-        'feat',
-        'fix',
-        'perf',
-        'style',
-        'docs',
-        'test',
-        'refactor',
-        'build',
-        'ci',
-        'chore',
-        'revert',
-        'wip',
-        'workflow',
-        'types',
-        'release',
-      ],
+      ['Feat', 'Fix', 'Mod', 'Style', 'Perf', 'Refactor', 'Revert', 'Test', 'Docs', 'Chore', 'Workflow', 'CI', 'Wip', 'Types'],
     ],
   },
 };