Parcourir la source

[Docs 0000] 补充项目文档,添加提交模板

houzekong il y a 1 an
Parent
commit
82daa49961
2 fichiers modifiés avec 30 ajouts et 2 suppressions
  1. 22 0
      .github/commit-template
  2. 8 2
      README.md

+ 22 - 0
.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

+ 8 - 2
README.md

@@ -1,3 +1,9 @@
-VentAnaly_6.0_APP
+## VentAnaly_6.0_APP
 
-手机端
+通风 6.0 手机端
+
+### 提交须知
+
+请手动设置提交模板,提交实例在模板注释中
+
+项目根目录下执行`git config commit.template .github/commit-template`