diff --git a/README.md b/README.md index 289a1f18..788fa764 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,94 @@ -# HM-SPMS +### 目录结构 -代码库 \ No newline at end of file +``` +ems +├─ 📁backup //不纳入git,工程备份目录 +├─ 📁data //不纳入git,工程配置数据 +├─ 📁hisdata //不纳入git,历史数据备份目录 +├─ 📁installer //系统安装脚本 +├─ 📁log //不纳入git,程序允许日志,按照应用/进程名区分目录 +├─ 📁platform //平台 +│ ├─ 📁common // +│ ├─ ├─📁database // +│ ├─ ├─ ├─📁initdata //关系库初始化的基础数据 +│ ├─ ├─ ├─📁initscript //数据库初始化脚本 +│ ├─ ├─📁sysconfig //存放可执行文件的相关配置,不经常修改的项,只跟进程相关,不跟工程配置相关的文件 +│ ├─ 📁windows10_debug、等 //可执行程序和库文件 +│ ├─ 📁src //源代码 +│ ├─ ├─📁3rd //第三方库源代码 +│ ├─ ├─📁application //通用功能后台服务、专业应用服务相关进程 如数控、联动、拓扑、时间表等 +│ ├─ ├─📁dbms //数据库管理系统相关进程 +│ ├─ ├─📁example //示例代码 +│ ├─ ├─📁fes //前置相关进程 +│ ├─ ├─📁gui //人机界面和组态 +│ ├─ ├─📁idl_files //Protobuff 定义文件、接口头文件、源文件 +│ ├─ ├─📁include //接口的头文件 +│ ├─ ├─📁net //网络管理相关进程 +│ ├─ ├─📁public //公共的接口,公共平台、日志等公共源码 +│ ├─ ├─📁service //各种平台服务,如数据处理服务,人工操作服务,报警服务,存盘服务等 +│ ├─ ├─📁sys //系统管理相关进程 +│ ├─ ├─📁tools //配置工具、调试工具等独立进程工具 +│ ├─ ├─📁temp //不纳入git,一些编译过程的临时文件 +│ ├─ ├─📄common.pri +│ ├─ ├─📄common_base.pri +│ ├─ ├─📄disable_dog_auth.pri +│ ├─ ├─📄src.pro +├─ 📁product //产品 +│ ├─ 📁common // +│ ├─ ├─📁database // +│ ├─ ├─ ├─📁initdata //关系库初始化的基础数据 +│ ├─ ├─ ├─📁initscript //数据库初始化脚本 +│ ├─ ├─📁sysconfig //存放可执行文件的相关配置,不经常修改的项,只跟进程相关,不跟工程配置相关的文件 +│ ├─ ├─📁license //不纳入git,授权信息 +│ ├─ ├─📁Schema // +│ ├─ 📁src // +│ ├─ ├─📁3rd //第三方库源代码 +│ ├─ ├─📁application //通用功能后台服务、专业应用服务相关进程 如数控、联动、拓扑、时间表等 +│ ├─ ├─📁dbms //数据库管理系统相关进程 +│ ├─ ├─📁example //示例代码,不列入pro项目工程中管理 +│ ├─ ├─📁fes //前置相关进程 +│ ├─ ├─📁gui //人机界面和组态 +│ ├─ ├─📁idl_files //Protobuff 定义文件、接口头文件、源文件 +│ ├─ ├─📁include //接口的头文件 +│ ├─ ├─📁net //网络管理相关进程 +│ ├─ ├─📁public //公共的接口,公共平台、日志等公共源码 +│ ├─ ├─📁service //各种平台服务,如数据处理服务,人工操作服务,报警服务,存盘服务等 +│ ├─ ├─📁sys //系统管理相关进程 +│ ├─ ├─📁tools //配置工具、调试工具等独立进程工具 +│ ├─ ├─📁z_discard //弃用的组件和代码 +│ ├─ ├─📄common.pri // +├─ 📁products //不纳入git,工程初始化数据,放在工程数据的仓库中管控 +├─ 📁resource //资源文件 +│ ├─ 📁zh //中文 +│ ├─ ├─📁public //第三方库源代码 +│ ├─ ├─ ├─📁dark //深色的资源库,优先用公共的,有特殊的才放在各自目录下管理 +│ ├─ ├─ ├─📁light //浅色的资源库,优先用公共的,有特殊的才放在各自目录下管理 +│ ├─ ├─📁style //第三方库源代码 +│ ├─ ├─ ├─📁dark //深色样式,默认先加载public.qss,后再加载各自的特定qss +│ ├─ ├─ ├─📁light //浅色样式,默认先加载public.qss,后再加载各自的特定qss +│ ├─ ├─📁gui、其他 //第三方库源代码 +│ ├─ ├─ ├─📁icon //各组件的特殊图标 +│ ├─ ├─ ├─📁translate //多语言翻译文件 +│ ├─ 📁en //英文, +│ ├─ ├─📁... //同中文 +├─ 📁support //支持的独立工具,如nginx、java等 +├─ 📁upgrade //系统升级相关 +├─ 📁web //web前端相关 +├─ 📄.gitignore +├─ 📄read.md +``` + + + +### 代码提交规范 + +- 'feat', // 新功能 feature +- 'fix', // 修复 bug +- 'docs', // 文档注释 +- 'style', // 代码格式/样式(不影响代码运行的变动) +- 'refactor', // 重构(既不增加新功能,也不是修复 bug) +- 'perf', // 性能优化 +- 'test', // 增加测试 +- 'chore', // 构建过程或辅助工具的变动 +- 'revert', // 回退 +- 'build' // 打包 \ No newline at end of file