更新

doc/CHANGELOG.md

@@ -0,0 +1,22 @@
+<a name="v2.0.0"></a>
+## [v2.0.0] - 2024-01-31
+
+### 新增功能
+- 支持netty mqtt broker ([#1]())
+- 支持多种编码协议管理([#2]())
+- 支持emqx5.0([#3]())
+
+### 功能优化
+- 设备列表卡片优化，设备详情页面优化
+- 物模型功能优化
+- 产品管理功能优化
+
+### 代码重构
+- java项目代码目录重新调整
+- 消息网关重构
+
+### 其他事务
+- 新增Git提交规范([#Git提交规范](https://gitee.com/kerwincui/wumei-smart/blob/master/doc/Git%E6%8F%90%E4%BA%A4%E8%A7%84%E8%8C%83.md))
+- 新增贡献者指南([#贡献者指南](https://gitee.com/kerwincui/wumei-smart/blob/master/doc/%E8%B4%A1%E7%8C%AE%E8%80%85%E6%8C%87%E5%8D%97.md))
+- 新增功能规划([#功能规划](https://gitee.com/kerwincui/wumei-smart/blob/master/RoadMap.md))
+- 修改项目AGPL3协议商用授权说明

doc/Git提交规范.md

@@ -0,0 +1,63 @@
+# 一，conventional commit(约定式提交)
+Conventional Commits 是一种用于给提交信息增加人机可读含义的规范。它提供了一组用于创建清晰的提交历史的简单规则。
+## 1.1 作用
+- 自动化生成 CHANGELOG
+- 基于提交类型，自动决定语义化的版本变更
+- 向项目相关合作开发者发送变更信心
+- 触发自动化构建和部署流程
+- 给开发者提供一个更加结构化的提交历史，便于减低对项目做贡献的难度
+## 1.2 提交格式
+提交说明的结构如下：
+<type>(<scope>): <subject>
+空行
+[可选的正文]
+空行
+[可选的脚注]
+### 1.2.1 Header
+Header部分只有一行，包括三个字段： type（必需）、scope（必需）和subject（必需）。
+
+#### （1）type 类型
+type用于说明 commit 的类别，只允许使用下面7个标识：
+- feat：新功能（feature）
+- fix：修补bug
+- docs：文档（documentation）
+- style： 格式（不影响代码运行的变动）
+- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+- test：增加测试
+- build：构建过程或辅助工具的变动
+#### （2）scope 范围
+scope用于说明 commit 影响的范围，比如指标模板、规则上下线等等，视项目不同而不同。
+#### （3）subject 主题
+subject是 commit 目的的简短描述，不超过50个字符。
+1. 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
+2. 第一个字母小写
+3. 结尾不加句号（.）
+### 1.2.2 Body 正文
+   Body 部分是对本次 commit 的详细描述，可以分成多行。
+1. 需要简要的列出各种正向或者反向的测试场景，测试通过，填pass。
+2. 增加修改人信息
+
+## 1.3 例子
+### 1.3.1 feat例子
+```
+feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能
+
+1. 规则上下线主流程，引擎正常订阅，fldl生成正常。 pass
+2. 规则上下线，传入不存在的规则编号，异常提示。 pass
+
+提交人：xxx
+```
+### 1.3.2 fix例子
+```
+fix(模型模块): 模型测试失败
+
+1. 导入mar模型，包含衍生字段。 pass
+2. 导入mar模型，不包含衍生字段。 pass
+
+提交人：xxx
+```
+## 1.4 IDEA插件推荐
+
+1. 安装路径：File->Settings->Plugins->Marketplace->搜索Conventional Commit，点击安装即可。
+2. 提交的时候点击中间的小红点创建提交消息，根据对话框提示填写相关信息即可生成规范的提交消息。
+

doc/贡献者指南.md

@@ -0,0 +1,69 @@
+> 非常欢迎参与项目贡献，我们致力于维护一个互相帮助，共同成长社区。
+
+# 贡献方式
+在Fastbee 社区，贡献方式有很多:
+
+- 💻代码：可以帮助社区完成一些任务、编写新的feature或者是修复一些bug；
+- ⚠️测试：可以来参与测试代码的编写，包括了单元测试、集成测试、e2e测试；
+- ✅编译：构建或者辅助工具建议，包括：Docker，K8s，CI/CD，辅助调试工具等；
+- 📖文档：可以编写或完善文档，来帮助用户更好地了解和使用 物联网平台；
+- 🤔讨论：可以参与 Fastbee 新的feature的讨论，将您的想法跟 Fastbee 融合；
+- 💬建议：也可以对项目或者社区提出一些建议，促进社区的良性发展；
+- ❗疑问：问出一个好的问题，同样也可以促进项目发展，拓宽思考方向；
+
+> 即便是小到错别字的修正我们也都非常欢迎 :)
+
+# 提PR有以下注意点
+PR统一在Gitee平台上进行提交，如果你不知道如何提交PR，可以在Gitee平台里去学习。这里不作说明。
+- fork后切换到develop分支，请以这个分支为开发基准。
+- 所有的PR提交到develop分支，这个分支为开发分支。
+- 如果你作了功能性的变动，请带上你的测试用例，测试用例规范可以参考之前的测试用例。
+- 所有的PR必须关联至少一个issue，如果没有相关issue，请自行创建一个。
+- 正式提交PR之前，请确保所有的测试用例都通过。
+- Git提交消息，需要按照[Git提交规范](./Git提交规范.md)。
+
+# 提交 Pull Request
+1. 首先您需要 Fork 目标仓库 Fastbee repository.
+2. 然后 用git命令 将代码下载到本地:
+
+```
+   git clone https://gitee.com/zhuangpengli/FastBee 
+```
+
+3. 下载完成后，请参考目标仓库README 文件对项目进行初始化。
+4. 接着，您可以参考如下命令进行代码的提交, 切换新的分支, 进行开发:
+
+```
+# 根据项目需要创建对应分支
+git checkout -b feat-xxx 或者 fix-xxx 等等
+```
+
+5. 提交 commit , commit 描述信息需要符合[约定格式](./Git提交规范.md).
+
+```
+git add <modified file/path>
+git commit -m '[docs]feature: necessary instructions' 
+```
+6. 推送到远程仓库
+```
+git push origin feat-xxx 
+```
+7. 然后您就可以在 Gitee 上发起新的 PR (Pull Request)。
+
+> 注意!!! PR 的标题需要符合我们的规范，并且在 PR 中写上必要的说明，来方便 Committer 和其他贡献者进行代码审查。等待PR代码被合并
+
+> 在提交了 PR 后，Committer 或者社区的小伙伴们会对您提交的代码进行审查（Code Review），会提出一些修改建议，或者是进行一些讨论，请及时关注您的PR。
+若后续需要改动，不需要发起一个新的 PR，在原有的分支上提交 commit 并推送到远程仓库后，PR会自动更新。
+
+
+# 代码被合并后
+在代码被合并后，您就可以在本地和远程仓库删除这个开发分支了：
+```
+git branch -d feat-xxx
+git push origin --delete feat-xxx在主分支上，
+```
+您可以执行以下操作来同步上游仓库：
+```
+git remote add upstream https://gitee.com/zhuangpengli/FastBee.git
+#Bind the remote warehouse, if it has been executed, it does not need to be executed againgit checkout master git pull upstream master
+```