修改ReadMe

This commit is contained in:
巴拉迪维 2021-09-02 14:35:57 +08:00
parent 36b0de7494
commit c039befd07
2 changed files with 11 additions and 10 deletions

View File

@ -1,26 +1,27 @@
## Gitlink Notification System
![](/api/attachments/365502?raw=true)
![](/api/attachments/365506?raw=true)
### 主要组成部分:
1. **xxl-job 调度管理中心** :提供对分布式的任务集中监控、管理等功能
2. **xxl-job 执行器** :消息中心的业务逻辑实现,目前只实现「系统通知」功能,后续可以考虑 `email-executor`、`text-message-executor` 等实现
3. **GNS-Writer**:给 `Forge业务层` 调用的 API 网,负责从业务逻辑层接受信息
3. **GNS-Writer**:给 `Forge业务层` 调用的 API 网,负责从业务逻辑层接受信息
4. **MQ**:独立运行的消息中间件服务
5. **GNS-Reader**:给 `Forge业务层` 调用的 API 网,负责提供业务数据
5. **GNS-Reader**:给 `Forge业务层` 调用的 API 网,负责提供业务数据
6. **Redis**:独立运行的缓存中间件服务
### 一些约定:
1. 默认分支为 `master` 分支,每更新一次线上负责,则会建立对应的 `release` 分支
2. **绝不接受直接 push 代码的任何行为**
3. 请使用如下方式参与协作:
3.1 首先 `fork` 本仓库到自己名下
3.2 `git checkout {remote}/master -b {local_branch_name}` 新建本地分支
3.3 在本地分支修改任务并推送到自己名下的仓库
3.4 在 [仓库首页](https://forgeplus.trustie.net/projects/Gitlink/gitlink-notification-system) 触发 pull request 并等待审核处理
4. 请务必在代码中必要的地方加入适当的注释
5. 请务必注意开源协议,并在代码文件中标出所遵从的协议详细信息以及作者
3请务必在代码中必要的地方加入适当的注释
4请务必注意开源协议并在代码文件中标出所遵从的协议详细信息以及作者
### 协作方式
1. 首先 `fork` 本仓库到自己名下
2. `git checkout {remote}/master -b {local_branch_name}` 新建本地分支
3. 在本地分支修改任务并推送到自己名下的仓库
4. 在 [仓库首页](https://forgeplus.trustie.net/projects/Gitlink/gitlink-notification-system) 触发 pull request 并等待审核处理

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB