注意 本文件他人请勿修改,如有修改需求,请提建议给作者
作者: Sharp
提交时间:2020/02/14
邮箱: yangcp@koal.com
手机: 13669191265 同微信
-
- 该项目是实现了基础业务中间件,以RPC的方式对外提供统一的接口
- 项目主要开发语言为C++,核心部分不支持C++11, 接口部分可以支持C++11
- 源文件的编码格式为UTF-8,推荐使用无BOM格式
- 源码注释规范为Doxygen 注释规范
- 本项目编码中命名规范采用 驼峰命名法
-
3rd/ 目录中存放的是一些引用的第三方资源
bin/ 目录存放的是项目的二进制文件输出目录
doc/ 目录存放的是项目除源码外的非二进制文档
include/ 目录存放的是一些全局头文件
pkg/ 目录存放的是各平台的打包脚本
src/ 目录存放的是项目的所有工程源文件
|__common/ 存放一些工具类
|__msglib/ IPC通讯的基础库
|__svc/ 聚合服务
|__tray/ 托盘GUI
|__tests/ 目录存放的是测试工程、源码文件 -
- master分支为主分支(保护分支),不能直接在master上进行修改代码和提交;
- develop分支为开发分支(保护分支),其他分支代码合并需要提交MR
- issues-#开头分支为开发分支,大家根据不同issues创建独立的功能分支,开发完成后MR合并到develop分支;
- fix分支为bug修复分支,需要根据实际情况对已发布的版本进行漏洞修复;
-
<type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer> 对格式的说明如下: type代表某次提交的类型,比如是修复一个bug还是增加一个新的 feature。所有的type类型如下: feat: 新增feature fix: 修复bug docs: 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等 style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑 refactor: 代码重构,没有加新功能或者修复bug perf: 优化相关,比如提升性能、体验 test: 测试用例,包括单元测试、集成测试等 chore: 改变构建流程、或者增加依赖库、工具等 revert: 回滚到上一个版本 格式要求: # 标题行:50个字符以内,描述主要变更内容 # # 主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括: # # * 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等 # * 他如何解决这个问题? 具体描述解决问题的步骤 # * 是否存在副作用、风险? # # 尾部:如果需要的化可以添加一个链接到issue地址或者其它文档,或者关闭某个issue。
-
采用四段式,v版本.里程碑.序号,如v1.1.12.32123
- 架构升级或架构重大调整,修改第1位
- 新功能上线或者模块大的调整,修改第2位
- bug修复上线,修改第3位
- 第四位是关联代码的commit id
-
- QT 5.6.3
- nanomsg 5.1
-
- windows win7 vs2010
- linux ubuntu16.10
- android ndk7
-
-
- [Cmake编译说明]
-