[Docs 0000] 更新README文档以及提交模板

.github/commit-template

@@ -1,22 +1,22 @@
-# Pick one keyword from below
-# Feat
-# Fix
-# Style
-# Perf
-# Refactor
-# Revert
-# Test
-# Docs
-# Chore
-# Workflow
-# CI
-# Mod
-# Wip
-# Types
-[Feat 0000] xxx
-
-Discription
-
-Associated Tasks
-
-Assignee
+# 从下列关键词中选取一项
+# 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,5 +1,3 @@
-
-
 **English** | [中文](./README.zh-CN.md)
 
 ## Feature
@@ -43,13 +41,13 @@ Open the project in Gitpod (free online dev environment for GitHub) and start co
 
 pnpm install
 
-```
+````
 
 - run
 
 ```bash
 pnpm serve
-```
+````
 
 - build
 
@@ -91,28 +89,15 @@ You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vb
 **Pull Request:**
 
 1. Fork code!
-2. Create your own branch: `git checkout -b feat/xxxx`
-3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
-4. Push your branch: `git push origin feat/xxxx`
-5. submit`pull request`
+2. Set up commit template: `git config commit.template .github/commit-template`
+3. Create your own branch: `git checkout -b feat/xxxx`
+4. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
+5. Push your branch: `git push origin feat/xxxx`
+6. submit`pull request`
 
 ## Git Contribution submission specification
 
-- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
-
-  - `feat` Add new features
-  - `fix` Fix the problem/BUG
-  - `style` The code style is related and does not affect the running result
-  - `perf` Optimization/performance improvement
-  - `refactor` Refactor
-  - `revert` Undo edit
-  - `test` Test related
-  - `docs` Documentation/notes
-  - `chore` Dependency update/scaffolding configuration modification etc.
-  - `workflow` Workflow improvements
-  - `ci` Continuous integration
-  - `types` Type definition file changes
-  - `wip` In development
+- details in .github/commit-template
 
 ## Related warehouse
 

README.zh-CN.md

@@ -1,8 +1,5 @@
-
-
 **中文** | [English](./README.md)
 
-
 ## 特性
 
 - **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发
@@ -13,7 +10,6 @@
 - **权限** 内置完善的动态路由权限生成方案
 - **组件** 二次封装了多个常用的组件
 
-
 ## 准备
 
 - [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
@@ -33,13 +29,13 @@
 
 pnpm install
 
-```
+````
 
 - 运行
 
 ```bash
 pnpm serve
-```
+````
 
 - 打包
 
@@ -47,7 +43,6 @@ pnpm serve
 pnpm build
 ```
 
-
 ## 更新日志
 
 [CHANGELOG](./CHANGELOG.zh_CN.md)
@@ -64,28 +59,15 @@ pnpm build
 **Pull Request:**
 
 1. Fork 代码!
-2. 创建自己的分支: `git checkout -b feat/xxxx`
-3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
-4. 推送您的分支: `git push origin feat/xxxx`
-5. 提交`pull request`
+2. 设置提交模板: `git config commit.template .github/commit-template`
+3. 创建自己的分支: `git checkout -b feat/xxxx`
+4. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
+5. 推送您的分支: `git push origin feat/xxxx`
+6. 提交`pull request`
 
 ## Git 贡献提交规范
 
-- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
-
-  - `feat` 增加新功能
-  - `fix` 修复问题/BUG
-  - `style` 代码风格相关无影响运行结果的
-  - `perf` 优化/性能提升
-  - `refactor` 重构
-  - `revert` 撤销修改
-  - `test` 测试相关
-  - `docs` 文档/注释
-  - `chore` 依赖更新/脚手架配置修改等
-  - `workflow` 工作流改进
-  - `ci` 持续集成
-  - `types` 类型定义文件更改
-  - `wip` 开发中
+- 参考模板.github/commit-template
 
 ## 浏览器支持
 
@@ -106,7 +88,6 @@ pnpm build
 - [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - 用于打包输出.gz|.brotil 文件
 - [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - 用于快速生成 svg 雪碧图
 
-
 ## 感谢
 
 <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height='120'>