diff --git a/README.md b/README.md index e69de29..88b5e80 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,35 @@ +# Git提交规范 + +## 提交格式 + +commit 提交信息时,必须是 **git commit -m '【提交类型】: [改动功能模块]【修改内容描述】'** 符合类型的才可以,**需要注意的是类型的后面需要用英文的 :,并且冒号后面是需要空一格的**。例如:git commit -m "fix: [光电吊舱]修复配置参数保存失效问题;" + +### git提交类型: + +``` +'feat', //新特性、新功能 +'fix', //修改bug +'docs', //文档修改 +'style', //代码格式修改, 注意不是 css 修改 +'refactor',//代码重构 +'perf', //优化相关,比如提升性能、体验 +'test', //测试用例修改 +'chore', //其他修改, 比如改变构建流程、或者增加依赖库、工具等 +'revert', //回滚到上一个版本 +'build', //编译相关的修改,例如发布版本、对项目构建或者依赖的改动 +'style', //代码风格调整 +'ci', /持续集成 +‘security’,//安全相关 +'i18n', //国际化 +‘l10n‘, //本地化 +'merge', //合并分支 +'hotfix', //紧急修复 +'dependencies',//依赖管理 +``` + +## 环境: + +Qt版本要求6.5.3以上,建议使用LTS版本6.5.3或最新LST6.8.1。编译器采用MSVC。 + + +