mirror of
https://gitee.com/beecue/fastbee.git
synced 2025-12-17 16:36:03 +08:00
删除冗余文件
This commit is contained in:
kerwincui
@@ -1,22 +0,0 @@
|
|||||||
name: 构建或者辅助工具建议
|
|
||||||
description: 构建过程或辅助工具
|
|
||||||
title: "[构建&辅助]: "
|
|
||||||
labels: ["build"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你的构建或者辅助工具建议？
|
|
||||||
description: 清晰并简洁地描述问题是什么？
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: issue创建要求
|
|
||||||
url: https://fastbee.cn/doc/
|
|
||||||
about: 不符合模板要求不便定位问题，可能会被管理员直接关闭
|
|
||||||
- name: fastbee帮助文档
|
|
||||||
url: https://fastbee.cn/doc/
|
|
||||||
about: 提供fastbee平台基本功能使用、介绍和常见问题解答
|
|
||||||
- name: Gitee 帮助中心
|
|
||||||
url: https://help.gitee.com/
|
|
||||||
about: 提供 Git 使用指南、教程、Gitee.com 平台基本功能使用、介绍和常见问题解答
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
name: 文档完善
|
|
||||||
description: 开发或者使用文档完善
|
|
||||||
title: "[文档]: "
|
|
||||||
labels: ["docs"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你需要哪些开发或者使用文档？
|
|
||||||
description: 你需要哪些开发或者使用文档？
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
name: 功能建议
|
|
||||||
description: 对本项目提出一个功能建议
|
|
||||||
title: "[功能建议]: "
|
|
||||||
labels: ["feat"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你的功能建议是否和某个问题相关？
|
|
||||||
description: 清晰并简洁地描述问题是什么，例如，当我...时，我总是感到困扰。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: desired-solution
|
|
||||||
attributes:
|
|
||||||
label: 你希望看到什么解决方案？
|
|
||||||
description: 清晰并简洁地描述你希望发生的事情。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: alternatives
|
|
||||||
attributes:
|
|
||||||
label: 你考虑过哪些替代方案？
|
|
||||||
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: 你有其他上下文或截图吗？
|
|
||||||
description: 在此处添加有关功能请求的任何其他上下文或截图。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
name: Bug 反馈
|
|
||||||
description: 当你在代码中发现了一个 Bug，导致应用崩溃或抛出异常，或者有一个组件存在问题，或者某些地方看起来不对劲。
|
|
||||||
title: "[Bug 反馈]: "
|
|
||||||
labels: ["fix"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢对项目的支持与关注。在提出问题之前，请确保你已查看相关开发或使用文档：
|
|
||||||
- https://fastbee.cn/doc/
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 这个问题是否已经存在？
|
|
||||||
options:
|
|
||||||
- label: 我已经搜索过现有的问题 (https://gitee.com/kerwincui/wumei-smart/issues)
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 如何复现
|
|
||||||
description: 请详细告诉我们如何复现你遇到的问题，如涉及代码，可提供一个最小代码示例，并使用反引号```附上它
|
|
||||||
placeholder: |
|
|
||||||
1. ...
|
|
||||||
2. ...
|
|
||||||
3. ...
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 预期结果
|
|
||||||
description: 请告诉我们你预期会发生什么。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 实际结果
|
|
||||||
description: 请告诉我们实际发生了什么。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 完整日志（报错时间点&日志行号），报错截图或抓包文件
|
|
||||||
description: 如果可以的话，上传任何关于 bug 的资料。
|
|
||||||
value: |
|
|
||||||
[在这里上传相关资料]
|
|
||||||
- type: dropdown
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: 版本
|
|
||||||
description: 你当前正在使用我们软件的哪个版本/分支？
|
|
||||||
options:
|
|
||||||
- master (默认)
|
|
||||||
- develop
|
|
||||||
- v2.0.0 (最新)
|
|
||||||
- v1.3.0
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
name: 问题咨询
|
|
||||||
description: 对本项目某个功能的问题咨询
|
|
||||||
title: "[问题咨询]: "
|
|
||||||
labels: ["question"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢你宝贵的建议，我们共同进步！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你对哪块的功能不了解，哪些流程不清楚，需要提供怎么样的帮助，需要提供哪块的技术文档？
|
|
||||||
description: 清晰并简洁地描述问题是什么，例如，当我...时，我总是感到困扰。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: 你有其他上下文或截图吗？
|
|
||||||
description: 在此处添加有关功能请求的任何其他上下文或截图。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 是否付费咨询
|
|
||||||
options:
|
|
||||||
- label: 我有意向付费咨询，希望快速解决该问题。
|
|
||||||
required: false
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
name: 代码重构
|
|
||||||
description: 代码重构（即不是新增功能，也不是修改bug的代码变动）
|
|
||||||
title: "[代码重构]: "
|
|
||||||
labels: ["refactor"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你觉得那个模块需要重新设代，哪块代码需要重新优化？
|
|
||||||
description: 你觉得那个模块需要重新设代，哪块代码需要重新优化？
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: desired-solution
|
|
||||||
attributes:
|
|
||||||
label: 你希望看到什么解决方案？
|
|
||||||
description: 清晰并简洁地描述你希望发生的事情。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: alternatives
|
|
||||||
attributes:
|
|
||||||
label: 你考虑过哪些替代方案？
|
|
||||||
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
name: 格式优化
|
|
||||||
description: 格式（不影响代码运行的变动）
|
|
||||||
title: "[格式优化]: "
|
|
||||||
labels: ["style"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你觉得那个的代码格式需要优化？
|
|
||||||
description: 你觉得那个的代码格式需要优化？
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
name: 测试用例完善
|
|
||||||
description: 测试用例完善，性能压测等
|
|
||||||
title: "[测试&性能]: "
|
|
||||||
labels: ["test"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你需要哪些测试用例，性能压测数据？
|
|
||||||
description: 你需要哪些测试用例，性能压测数据？
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
<!-- 请务必在创建PR前，在右侧 Labels 选项中加上label的其中一个: [feature]、[fix]、[documentation] 。以便于Actions自动生成Releases时自动对PR进行归类。-->
|
|
||||||
|
|
||||||
**在提出此拉取请求时，我确认了以下几点（请复选框）：**
|
|
||||||
|
|
||||||
- [ ] 我已阅读并理解[贡献者指南](../doc/贡献者指南.md)。
|
|
||||||
- [ ] 我已检查没有与此请求重复的拉取请求。
|
|
||||||
- [ ] 我已经考虑过，并确认这份呈件对其他人很有价值。
|
|
||||||
- [ ] 我接受此提交可能不会被使用，并根据维护人员的意愿关闭拉取请求。
|
|
||||||
|
|
||||||
### 一、内容说明（相关的Issue）
|
|
||||||
|
|
||||||
|
|
||||||
### 二、变更内容
|
|
||||||
* 2.1 关联PR列表
|
|
||||||
|
|
||||||
* 2.2 数据库和部署说明
|
|
||||||
1. 常规更新
|
|
||||||
2. 重启unicorn
|
|
||||||
3. 重启sidekiq
|
|
||||||
4. 迁移任务：是否有迁移任务，没有写 "无"
|
|
||||||
5. rake脚本：`bundle exec xxx RAILS_ENV = production`；没有写 "无"
|
|
||||||
|
|
||||||
* 2.4 其他技术优化内容（做了什么，变更了什么）
|
|
||||||
- 重构了 xxxx 代码
|
|
||||||
- xxxx 算法优化
|
|
||||||
|
|
||||||
|
|
||||||
* 2.5 废弃通知（什么字段、方法弃用？）
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* 2.6 后向不兼容变更（是否有无法向后兼容的变更？）
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 四、研发自测点（自测哪些？冒烟用例全部自测？）
|
|
||||||
自测测试结论：
|
|
||||||
|
|
||||||
|
|
||||||
### 五、测试关注点（选填，有影响时填写，需要重点关注的、可能会忽略的地方）
|
|
||||||
检查点：
|
|
||||||
|
|
||||||
| 需求名称 | 是否影响xx公共模块 | 是否需要xx功能 | 需求升级是否依赖其他子产品 |
|
|
||||||
|------|------------|----------|---------------|
|
|
||||||
| xxx | 否 | 需要 | 不需要 |
|
|
||||||
| | | | |
|
|
||||||
|
|
||||||
接口测试：
|
|
||||||
|
|
||||||
性能测试：
|
|
||||||
|
|
||||||
并发测试：
|
|
||||||
|
|
||||||
其他：
|
|
||||||
|
|
||||||
22
.github/ISSUE_TEMPLATE/build.yml
vendored
22
.github/ISSUE_TEMPLATE/build.yml
vendored
@@ -1,22 +0,0 @@
|
|||||||
name: 构建或者辅助工具建议
|
|
||||||
description: 构建过程或辅助工具
|
|
||||||
title: "[构建&辅助]: "
|
|
||||||
labels: ["build"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你的构建或者辅助工具建议？
|
|
||||||
description: 清晰并简洁地描述问题是什么？
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
11
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,11 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: issue创建要求
|
|
||||||
url: https://fastbee.cn/doc/
|
|
||||||
about: 不符合模板要求不便定位问题，可能会被管理员直接关闭
|
|
||||||
- name: fastbee帮助文档
|
|
||||||
url: https://fastbee.cn/doc/
|
|
||||||
about: 提供fastbee平台基本功能使用、介绍和常见问题解答
|
|
||||||
- name: Gitee 帮助中心
|
|
||||||
url: https://help.gitee.com/
|
|
||||||
about: 提供 Git 使用指南、教程、Gitee.com 平台基本功能使用、介绍和常见问题解答
|
|
||||||
22
.github/ISSUE_TEMPLATE/docs.yml
vendored
22
.github/ISSUE_TEMPLATE/docs.yml
vendored
@@ -1,22 +0,0 @@
|
|||||||
name: 文档完善
|
|
||||||
description: 开发或者使用文档完善
|
|
||||||
title: "[文档]: "
|
|
||||||
labels: ["docs"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你需要哪些开发或者使用文档？
|
|
||||||
description: 你需要哪些开发或者使用文档？
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
43
.github/ISSUE_TEMPLATE/feat.yml
vendored
43
.github/ISSUE_TEMPLATE/feat.yml
vendored
@@ -1,43 +0,0 @@
|
|||||||
name: 功能建议
|
|
||||||
description: 对本项目提出一个功能建议
|
|
||||||
title: "[功能建议]: "
|
|
||||||
labels: ["feat"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你的功能建议是否和某个问题相关？
|
|
||||||
description: 清晰并简洁地描述问题是什么，例如，当我...时，我总是感到困扰。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: desired-solution
|
|
||||||
attributes:
|
|
||||||
label: 你希望看到什么解决方案？
|
|
||||||
description: 清晰并简洁地描述你希望发生的事情。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: alternatives
|
|
||||||
attributes:
|
|
||||||
label: 你考虑过哪些替代方案？
|
|
||||||
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: 你有其他上下文或截图吗？
|
|
||||||
description: 在此处添加有关功能请求的任何其他上下文或截图。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
56
.github/ISSUE_TEMPLATE/fix.yml
vendored
56
.github/ISSUE_TEMPLATE/fix.yml
vendored
@@ -1,56 +0,0 @@
|
|||||||
name: Bug 反馈
|
|
||||||
description: 当你在代码中发现了一个 Bug，导致应用崩溃或抛出异常，或者有一个组件存在问题，或者某些地方看起来不对劲。
|
|
||||||
title: "[Bug 反馈]: "
|
|
||||||
labels: ["fix"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢对项目的支持与关注。在提出问题之前，请确保你已查看相关开发或使用文档：
|
|
||||||
- https://fastbee.cn/doc/
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 这个问题是否已经存在？
|
|
||||||
options:
|
|
||||||
- label: 我已经搜索过现有的问题 (https://gitee.com/kerwincui/wumei-smart/issues)
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 如何复现
|
|
||||||
description: 请详细告诉我们如何复现你遇到的问题，如涉及代码，可提供一个最小代码示例，并使用反引号```附上它
|
|
||||||
placeholder: |
|
|
||||||
1. ...
|
|
||||||
2. ...
|
|
||||||
3. ...
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 预期结果
|
|
||||||
description: 请告诉我们你预期会发生什么。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 实际结果
|
|
||||||
description: 请告诉我们实际发生了什么。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: 完整日志（报错时间点&日志行号），报错截图或抓包文件
|
|
||||||
description: 如果可以的话，上传任何关于 bug 的资料。
|
|
||||||
value: |
|
|
||||||
[在这里上传相关资料]
|
|
||||||
- type: dropdown
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: 版本
|
|
||||||
description: 你当前正在使用我们软件的哪个版本/分支？
|
|
||||||
options:
|
|
||||||
- master (默认)
|
|
||||||
- develop
|
|
||||||
- v2.0.0 (最新)
|
|
||||||
- v1.3.0
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
29
.github/ISSUE_TEMPLATE/question.yml
vendored
29
.github/ISSUE_TEMPLATE/question.yml
vendored
@@ -1,29 +0,0 @@
|
|||||||
name: 问题咨询
|
|
||||||
description: 对本项目某个功能的问题咨询
|
|
||||||
title: "[问题咨询]: "
|
|
||||||
labels: ["question"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢你宝贵的建议，我们共同进步！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你对哪块的功能不了解，哪些流程不清楚，需要提供怎么样的帮助，需要提供哪块的技术文档？
|
|
||||||
description: 清晰并简洁地描述问题是什么，例如，当我...时，我总是感到困扰。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: 你有其他上下文或截图吗？
|
|
||||||
description: 在此处添加有关功能请求的任何其他上下文或截图。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 是否付费咨询
|
|
||||||
options:
|
|
||||||
- label: 我有意向付费咨询，希望快速解决该问题。
|
|
||||||
required: false
|
|
||||||
36
.github/ISSUE_TEMPLATE/refactor.yml
vendored
36
.github/ISSUE_TEMPLATE/refactor.yml
vendored
@@ -1,36 +0,0 @@
|
|||||||
name: 代码重构
|
|
||||||
description: 代码重构（即不是新增功能，也不是修改bug的代码变动）
|
|
||||||
title: "[代码重构]: "
|
|
||||||
labels: ["refactor"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你觉得那个模块需要重新设代，哪块代码需要重新优化？
|
|
||||||
description: 你觉得那个模块需要重新设代，哪块代码需要重新优化？
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: desired-solution
|
|
||||||
attributes:
|
|
||||||
label: 你希望看到什么解决方案？
|
|
||||||
description: 清晰并简洁地描述你希望发生的事情。
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: alternatives
|
|
||||||
attributes:
|
|
||||||
label: 你考虑过哪些替代方案？
|
|
||||||
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
22
.github/ISSUE_TEMPLATE/style.yml
vendored
22
.github/ISSUE_TEMPLATE/style.yml
vendored
@@ -1,22 +0,0 @@
|
|||||||
name: 格式优化
|
|
||||||
description: 格式（不影响代码运行的变动）
|
|
||||||
title: "[格式优化]: "
|
|
||||||
labels: ["style"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你觉得那个的代码格式需要优化？
|
|
||||||
description: 你觉得那个的代码格式需要优化？
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
22
.github/ISSUE_TEMPLATE/test.yml
vendored
22
.github/ISSUE_TEMPLATE/test.yml
vendored
@@ -1,22 +0,0 @@
|
|||||||
name: 测试用例完善
|
|
||||||
description: 测试用例完善，性能压测等
|
|
||||||
title: "[测试&性能]: "
|
|
||||||
labels: ["test"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢提出功能建议，我们将仔细考虑！
|
|
||||||
- type: textarea
|
|
||||||
id: related-problem
|
|
||||||
attributes:
|
|
||||||
label: 你需要哪些测试用例，性能压测数据？
|
|
||||||
description: 你需要哪些测试用例，性能压测数据？
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: 意向参与贡献
|
|
||||||
options:
|
|
||||||
- label: 我有意向参与具体功能的开发实现并将代码贡献到社区
|
|
||||||
required: false
|
|
||||||
56
.github/PULL_REQUEST_TEMPLATE.zh-CN.md
vendored
56
.github/PULL_REQUEST_TEMPLATE.zh-CN.md
vendored
@@ -1,56 +0,0 @@
|
|||||||
<!-- 请务必在创建PR前，在右侧 Labels 选项中加上label的其中一个: [feature]、[fix]、[documentation] 。以便于Actions自动生成Releases时自动对PR进行归类。-->
|
|
||||||
|
|
||||||
**在提出此拉取请求时，我确认了以下几点（请复选框）：**
|
|
||||||
|
|
||||||
- [ ] 我已阅读并理解[贡献者指南](../doc/贡献者指南.md)。
|
|
||||||
- [ ] 我已检查没有与此请求重复的拉取请求。
|
|
||||||
- [ ] 我已经考虑过，并确认这份呈件对其他人很有价值。
|
|
||||||
- [ ] 我接受此提交可能不会被使用，并根据维护人员的意愿关闭拉取请求。
|
|
||||||
|
|
||||||
|
|
||||||
### 一、内容说明（相关的Issue）
|
|
||||||
|
|
||||||
|
|
||||||
### 二、变更内容
|
|
||||||
* 2.1 关联PR列表
|
|
||||||
|
|
||||||
* 2.2 数据库和部署说明
|
|
||||||
1. 常规更新
|
|
||||||
2. 重启unicorn
|
|
||||||
3. 重启sidekiq
|
|
||||||
4. 迁移任务：是否有迁移任务，没有写 "无"
|
|
||||||
5. rake脚本：`bundle exec xxx RAILS_ENV = production`；没有写 "无"
|
|
||||||
|
|
||||||
* 2.4 其他技术优化内容（做了什么，变更了什么）
|
|
||||||
- 重构了 xxxx 代码
|
|
||||||
- xxxx 算法优化
|
|
||||||
|
|
||||||
|
|
||||||
* 2.5 废弃通知（什么字段、方法弃用？）
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* 2.6 后向不兼容变更（是否有无法向后兼容的变更？）
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 四、研发自测点（自测哪些？冒烟用例全部自测？）
|
|
||||||
自测测试结论：
|
|
||||||
|
|
||||||
|
|
||||||
### 五、测试关注点（选填，有影响时填写，需要重点关注的、可能会忽略的地方）
|
|
||||||
检查点：
|
|
||||||
|
|
||||||
| 需求名称 | 是否影响xx公共模块 | 是否需要xx功能 | 需求升级是否依赖其他子产品 |
|
|
||||||
|------|------------|----------|---------------|
|
|
||||||
| xxx | 否 | 需要 | 不需要 |
|
|
||||||
| | | | |
|
|
||||||
|
|
||||||
接口测试：
|
|
||||||
|
|
||||||
性能测试：
|
|
||||||
|
|
||||||
并发测试：
|
|
||||||
|
|
||||||
其他：
|
|
||||||
|
|
||||||
0
.github/issue_template.md
vendored
0
.github/issue_template.md
vendored
0
.github/workflows/publish-docker.yml
vendored
0
.github/workflows/publish-docker.yml
vendored
@@ -1,53 +0,0 @@
|
|||||||
version: '1.0'
|
|
||||||
name: branch-pipeline
|
|
||||||
displayName: BranchPipeline
|
|
||||||
stages:
|
|
||||||
- stage:
|
|
||||||
name: compile
|
|
||||||
displayName: 编译
|
|
||||||
steps:
|
|
||||||
- step: build@maven
|
|
||||||
name: build_maven
|
|
||||||
displayName: Maven 构建
|
|
||||||
# 支持6、7、8、9、10、11六个版本
|
|
||||||
jdkVersion: 8
|
|
||||||
# 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本
|
|
||||||
mavenVersion: 3.3.9
|
|
||||||
# 构建命令
|
|
||||||
commands:
|
|
||||||
- mvn -B clean package -Dmaven.test.skip=true
|
|
||||||
# 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除
|
|
||||||
artifacts:
|
|
||||||
# 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址
|
|
||||||
- name: BUILD_ARTIFACT
|
|
||||||
# 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录
|
|
||||||
path:
|
|
||||||
- ./target
|
|
||||||
- step: publish@general_artifacts
|
|
||||||
name: publish_general_artifacts
|
|
||||||
displayName: 上传制品
|
|
||||||
# 上游构建任务定义的产物名，默认BUILD_ARTIFACT
|
|
||||||
dependArtifact: BUILD_ARTIFACT
|
|
||||||
# 上传到制品库时的制品命名，默认output
|
|
||||||
artifactName: output
|
|
||||||
dependsOn: build_maven
|
|
||||||
- stage:
|
|
||||||
name: release
|
|
||||||
displayName: 发布
|
|
||||||
steps:
|
|
||||||
- step: publish@release_artifacts
|
|
||||||
name: publish_release_artifacts
|
|
||||||
displayName: '发布'
|
|
||||||
# 上游上传制品任务的产出
|
|
||||||
dependArtifact: output
|
|
||||||
# 发布制品版本号
|
|
||||||
version: '1.0.0.0'
|
|
||||||
# 是否开启版本号自增，默认开启
|
|
||||||
autoIncrement: true
|
|
||||||
triggers:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
exclude:
|
|
||||||
- master
|
|
||||||
include:
|
|
||||||
- .*
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
version: '1.0'
|
|
||||||
name: master-pipeline
|
|
||||||
displayName: MasterPipeline
|
|
||||||
stages:
|
|
||||||
- stage:
|
|
||||||
name: compile
|
|
||||||
displayName: 编译
|
|
||||||
steps:
|
|
||||||
- step: build@maven
|
|
||||||
name: build_maven
|
|
||||||
displayName: Maven 构建
|
|
||||||
# 支持6、7、8、9、10、11六个版本
|
|
||||||
jdkVersion: 8
|
|
||||||
# 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本
|
|
||||||
mavenVersion: 3.3.9
|
|
||||||
# 构建命令
|
|
||||||
commands:
|
|
||||||
- mvn -B clean package -Dmaven.test.skip=true
|
|
||||||
# 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除
|
|
||||||
artifacts:
|
|
||||||
# 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址
|
|
||||||
- name: BUILD_ARTIFACT
|
|
||||||
# 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录
|
|
||||||
path:
|
|
||||||
- ./target
|
|
||||||
- step: publish@general_artifacts
|
|
||||||
name: publish_general_artifacts
|
|
||||||
displayName: 上传制品
|
|
||||||
# 上游构建任务定义的产物名，默认BUILD_ARTIFACT
|
|
||||||
dependArtifact: BUILD_ARTIFACT
|
|
||||||
# 上传到制品库时的制品命名，默认output
|
|
||||||
artifactName: output
|
|
||||||
dependsOn: build_maven
|
|
||||||
- stage:
|
|
||||||
name: release
|
|
||||||
displayName: 发布
|
|
||||||
steps:
|
|
||||||
- step: publish@release_artifacts
|
|
||||||
name: publish_release_artifacts
|
|
||||||
displayName: '发布'
|
|
||||||
# 上游上传制品任务的产出
|
|
||||||
dependArtifact: output
|
|
||||||
# 发布制品版本号
|
|
||||||
version: '1.0.0.0'
|
|
||||||
# 是否开启版本号自增，默认开启
|
|
||||||
autoIncrement: true
|
|
||||||
triggers:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
include:
|
|
||||||
- master
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
version: '1.0'
|
|
||||||
name: pipeline-docker
|
|
||||||
displayName: 构建镜像
|
|
||||||
triggers:
|
|
||||||
trigger: auto
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
precise:
|
|
||||||
- master
|
|
||||||
commitMessages:
|
|
||||||
include:
|
|
||||||
- ^deploy-docker
|
|
||||||
stages:
|
|
||||||
- name: stage-5ecf171c
|
|
||||||
displayName: 项目打包
|
|
||||||
strategy: naturally
|
|
||||||
trigger: auto
|
|
||||||
executor:
|
|
||||||
- kerwincui
|
|
||||||
steps:
|
|
||||||
- step: build@maven
|
|
||||||
name: build_maven
|
|
||||||
displayName: Maven 构建后端
|
|
||||||
jdkVersion: '8'
|
|
||||||
mavenVersion: 3.6.1
|
|
||||||
commands:
|
|
||||||
- cd ./springboot
|
|
||||||
- mvn -B clean package -Dmaven.test.skip=true
|
|
||||||
artifacts:
|
|
||||||
- name: BUILD_JAVA
|
|
||||||
path:
|
|
||||||
- ./springboot/wumei-admin/target/wumei-admin.jar
|
|
||||||
settings: []
|
|
||||||
strategy:
|
|
||||||
retry: '0'
|
|
||||||
- step: build@nodejs
|
|
||||||
name: build_nodejs
|
|
||||||
displayName: Nodejs 构建前端
|
|
||||||
nodeVersion: 14.16.0
|
|
||||||
commands:
|
|
||||||
- cd ./vue
|
|
||||||
- npm install --registry=https://registry.npm.taobao.org \
|
|
||||||
- '&& rm -rf ./dist && npm run build:prod'
|
|
||||||
artifacts:
|
|
||||||
- name: BUILD_VUE
|
|
||||||
path:
|
|
||||||
- ./vue/dist
|
|
||||||
strategy:
|
|
||||||
retry: '0'
|
|
||||||
- name: stage-f5631c9e
|
|
||||||
displayName: 上传打包文件
|
|
||||||
strategy: naturally
|
|
||||||
trigger: auto
|
|
||||||
executor:
|
|
||||||
- kerwincui
|
|
||||||
steps:
|
|
||||||
- step: publish@general_artifacts
|
|
||||||
name: publish_general_artifacts_java
|
|
||||||
displayName: 上传后端制品
|
|
||||||
dependArtifact: BUILD_JAVA
|
|
||||||
artifactName: springboot
|
|
||||||
strategy:
|
|
||||||
retry: '0'
|
|
||||||
- step: publish@general_artifacts
|
|
||||||
name: publish_general_artifacts_vue
|
|
||||||
displayName: 上传前端制品
|
|
||||||
dependArtifact: BUILD_VUE
|
|
||||||
artifactName: vue
|
|
||||||
strategy:
|
|
||||||
retry: '0'
|
|
||||||
- name: stage-59a550ac
|
|
||||||
displayName: 构建镜像
|
|
||||||
strategy: naturally
|
|
||||||
trigger: auto
|
|
||||||
executor:
|
|
||||||
- kerwincui
|
|
||||||
steps:
|
|
||||||
- step: build@docker
|
|
||||||
name: build_docker
|
|
||||||
displayName: 镜像构建
|
|
||||||
type: cert
|
|
||||||
certificate: kerwincui-docker
|
|
||||||
tag: kerwincui/wumei-smart:1.01
|
|
||||||
dockerfile: ./docker/Dockerfile
|
|
||||||
context: ./docker
|
|
||||||
artifacts:
|
|
||||||
- ${BUILD_JAVA}
|
|
||||||
- ${BUILD_VUE}
|
|
||||||
isCache: true
|
|
||||||
strategy:
|
|
||||||
retry: '0'
|
|
||||||
permissions:
|
|
||||||
- role: admin
|
|
||||||
members:
|
|
||||||
- kerwincui
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
version: '1.0'
|
|
||||||
name: pr-pipeline
|
|
||||||
displayName: PRPipeline
|
|
||||||
stages:
|
|
||||||
- stage:
|
|
||||||
name: compile
|
|
||||||
displayName: 编译
|
|
||||||
steps:
|
|
||||||
- step: build@maven
|
|
||||||
name: build_maven
|
|
||||||
displayName: Maven 构建
|
|
||||||
# 支持6、7、8、9、10、11六个版本
|
|
||||||
jdkVersion: 8
|
|
||||||
# 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本
|
|
||||||
mavenVersion: 3.3.9
|
|
||||||
# 构建命令
|
|
||||||
commands:
|
|
||||||
- mvn -B clean package -Dmaven.test.skip=true
|
|
||||||
# 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除
|
|
||||||
artifacts:
|
|
||||||
# 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址
|
|
||||||
- name: BUILD_ARTIFACT
|
|
||||||
# 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录
|
|
||||||
path:
|
|
||||||
- ./target
|
|
||||||
- step: publish@general_artifacts
|
|
||||||
name: publish_general_artifacts
|
|
||||||
displayName: 上传制品
|
|
||||||
# 上游构建任务定义的产物名，默认BUILD_ARTIFACT
|
|
||||||
dependArtifact: BUILD_ARTIFACT
|
|
||||||
# 构建产物制品库，默认default，系统默认创建
|
|
||||||
artifactRepository: default
|
|
||||||
# 上传到制品库时的制品命名，默认output
|
|
||||||
artifactName: output
|
|
||||||
dependsOn: build_maven
|
|
||||||
triggers:
|
|
||||||
pr:
|
|
||||||
branches:
|
|
||||||
include:
|
|
||||||
- master
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
<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协议商用授权说明
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
# 一，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. 提交的时候点击中间的小红点创建提交消息，根据对话框提示填写相关信息即可生成规范的提交消息。
|
|
||||||
|
|
||||||
69
doc/贡献者指南.md
69
doc/贡献者指南.md
@@ -1,69 +0,0 @@
|
|||||||
> 非常欢迎参与项目贡献，我们致力于维护一个互相帮助，共同成长社区。
|
|
||||||
|
|
||||||
# 贡献方式
|
|
||||||
在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
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user