From 3e145e22ae7eb75a5917c70a4d2e5cdec7081dda Mon Sep 17 00:00:00 2001 From: smallstonesk <575913857@qq.com> Date: Mon, 7 Dec 2020 22:07:00 +0800 Subject: [PATCH 1/7] deps: upgrade x6 version to fix node/edge moved listeners --- packages/core/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/package.json b/packages/core/package.json index f128304..d728ac9 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -37,7 +37,7 @@ }, "dependencies": { "@ant-design/icons": "^4.0.6", - "@antv/x6": "^0.13.0", + "@antv/x6": "^1.3.0", "ace-builds": "^1.4.12", "antd": "^4.5.3", "axios": "^0.21.0", From 04dc0f2d66514d7417e0c40f2f238c5c75393c93 Mon Sep 17 00:00:00 2001 From: smallstonesk <575913857@qq.com> Date: Wed, 9 Dec 2020 14:23:48 +0800 Subject: [PATCH 2/7] docs: update repo introduction --- README.md | 48 +++++++++++++++++++++++++++++------------ README.zh-CN.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+), 14 deletions(-) create mode 100644 README.zh-CN.md diff --git a/README.md b/README.md index 71c231c..67bb1ae 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,44 @@ # iMove -> 通过面向函数的流程可视化提高逻辑元件(ui、api)复用 +
+ +
-
- -
+iMove is a logic-reusable, function-oriented and process visualized JavaScript tool library. ## Features +- [x] **Process visualization:** easy to draw flow chart, logical expression is more intuitive and easy to understand +- [x] **Logic re-usage:** iMove nodes support re-using, and every node is configurable +- [x] **Flexible**: only the code is required, each iMove node is extendable and plugin can be integrated +- [ ] **Multi-language compilation**: no language compilation limitation (e.g. supports JavaScript, Java compilation) -## Install +## Get started +### Step 1. Prepare -## Usages +Download this project, install dependencies and start the example. +```bash +git clone https://github.com/imgcook/imove.git +cd example +npm install +npm start +``` + +### Step 2. Draw a flowchart + +Drag nodes from the left panel and drop them into the center to draw a flowchart. + +![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg) + +### Step 3. Config iMove nodes + +Select node, change node's display name and completes code editing. + +![flowchart-usage1](https://img.alicdn.com/tfs/TB1z6DKoZieb18jSZFvXXaI3FXa-1924-1125.png) + +![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png) ## Contributing @@ -23,15 +48,10 @@ 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request -## 版本历史 - -- v0.3.0 初始化版本 - -## 欢迎fork和反馈 +## Welcome fork and feedbacks -如有建议或意见,请在issue提问或邮件 +If you have suggestion, welcome github [issues](https://github.com/imgcook/imove/issues). ## License -this repo is released under the [MIT -License](http://www.opensource.org/licenses/MIT). +This repo is released under the [MIT License](http://www.opensource.org/licenses/MIT). diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..dc2c1f6 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,57 @@ +# iMove + +
+ +
+ +iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。 + +## 特性 + +- [x] **流程可视化**: 上手简单,绘图方便,逻辑表达更直观,易于理解 +- [x] **逻辑复用**: iMove 节点支持复用,单节点支持参数配置 +- [x] **灵活可扩展**: 仅需写一个函数,节点可扩展,支持插件集成 +- [ ] **多语言编译**: 无语言编译出码限制(例: 支持 JavaScript, Java 编译出码) + +## 快速开始 + +### 步骤 1. 准备 + +下载仓库,安装并启动 + +```bash +$ git clone https://github.com/imgcook/imove.git +$ cd ./imove/example +$ npm install +$ npm start +``` + +### 步骤 2. 绘制流程图 + +从左侧拖动节点至中央画布,绘制流程图 + +![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg) + +### 步骤 3. 配置节点 + +选择节点,修改节点名,编辑节点代码 + +![flowchart-usage1](https://img.alicdn.com/tfs/TB1z6DKoZieb18jSZFvXXaI3FXa-1924-1125.png) + +![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png) + +## 贡献 + +1. Fork 仓库 +2. 创建分支 (`git checkout -b my-new-feature`) +3. 提交修改 (`git commit -am 'Add some feature'`) +4. 推送 (`git push origin my-new-feature`) +5. 创建 PR + +## 欢迎fork和反馈 + +如有建议或意见,欢迎在 github [issues](https://github.com/imgcook/imove/issues) 区提问 + +## 协议 + +本仓库遵循 [MIT 协议](http://www.opensource.org/licenses/MIT) From f8d9f095029ca69e6eb57d427a8708c33990ca1a Mon Sep 17 00:00:00 2001 From: smallstonesk <575913857@qq.com> Date: Wed, 9 Dec 2020 14:44:52 +0800 Subject: [PATCH 3/7] docs: add language change link --- README.md | 6 +++++- README.zh-CN.md | 7 ++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 67bb1ae..1901c7c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,11 @@ -iMove is a logic-reusable, function-oriented and process visualized JavaScript tool library. +

+ iMove is a logic-reusable, function-oriented and process visualized JavaScript tool library. +

+ +English | [简体中文](./README.zh-CN.md) ## Features diff --git a/README.zh-CN.md b/README.zh-CN.md index dc2c1f6..8f7f17e 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,7 +4,12 @@ -iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。 +

+ iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。 +

+ +[English](./README.md) | 简体中文 + ## 特性 From a58059d2c8d9cc07dfa931ef5514a734548e3c22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8B=BC=E5=8F=94?= Date: Wed, 9 Dec 2020 14:46:46 +0800 Subject: [PATCH 4/7] docs: Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1901c7c..95f90d6 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ English | [简体中文](./README.zh-CN.md) Download this project, install dependencies and start the example. ```bash -git clone https://github.com/imgcook/imove.git -cd example -npm install -npm start +$ git clone https://github.com/imgcook/imove.git +$ cd example +$ npm install +$ npm start // run example server ``` ### Step 2. Draw a flowchart From c9ce7730c21330b0d6a2100fb2044cfd571fcbfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8B=BC=E5=8F=94?= Date: Wed, 9 Dec 2020 15:04:16 +0800 Subject: [PATCH 5/7] docs: add CONTRIBUTING --- .all-contributorsrc | 14 +++ CONTRIBUTING.md | 205 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 16 ++++ 3 files changed, 235 insertions(+) create mode 100644 .all-contributorsrc create mode 100644 CONTRIBUTING.md diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..1c2bd12 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,14 @@ +{ + "projectName": "iMove", + "projectOwner": "i5ting", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": true, + "commitConvention": "angular", + "contributors": [], + "contributorsPerLine": 7 +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9707be6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,205 @@ +# 代码贡献规范 + +有任何疑问,欢迎提交 [issue](https://github.com/imgcook/imove/issues), +或者直接修改提交 [PR](https://github.com/imgcook/imove/pulls)! + +## 提交 issue + +- 请确定 issue 的类型。 +- 请避免提交重复的 issue,在提交之前搜索现有的 issue。 +- 在标签(分类参考**标签分类**), 标题 或者内容中体现明确的意图。 + +随后 imove 负责人会确认 issue 意图,更新合适的标签,关联 milestone,指派开发者。 + +标签可分为两类,type 和 scope + +- type: issue 的类型,如 `feature`, `bug`, `documentation`, `performance`, `support` ... +- scope: 修改文件的范围,如 `core: xx`,`plugin: xx`,`deps: xx` + +### 常用标签说明 + +- `support`: issue 提出的问题需要开发者协作排查,咨询,调试等等日常技术支持。 +- `bug`: 一旦发现可能是 bug 的问题,请打上 `bug`,然后等待确认,一旦确认是 bug,此 issue 会被再打上 `confirmed`。 + - 此时 issue 会被非常高的优先级进行处理。 + - 如果此 bug 是正在影响线上应用正常运行,会再打上 `critical`,代表是最高优先级,需要马上立刻处理! + - bug 会在最低需要修复的版本进行修复,如是在 `0.9.x` 要修复的,而当前最新版本是 `1.1.x`, + 那么此 issue 还会被打上 `0.9`,`0.10`,`1.0`,`1.1`,代表需要修复到这些版本。 +- `core: xx`: 代表 issue 跟 core 内核相关,如 `core: antx` 代表跟 `antx` 配置相关。 +- `plugin: xx`: 代表 issue 跟插件相关,如 `deps: session` 代表跟 `session` 插件相关。 +- `deps: xx`: 代表 issue 跟 `dependencies` 模块相关,如 `deps: egg-cors` 代表跟 `egg-cors` 模块相关。 +- `chore: documentation`: 代表发现了文档相关问题,需要修复文档说明。 +- `cbd`: 代表跟服务器部署相关 + +## 编写文档 + +所有功能点必须提交配套文档,文档须满足以下要求 + +- 必须说清楚问题的几个方面:what(是什么),why(为什么),how(怎么做),可根据问题的特性有所侧重。 +- how 部分必须包含详尽完整的操作步骤,必要时附上 **足够简单,可运行** 的范例代码, +所有范例代码放在 [imove/examples](https://github.com/imgcook/imove) 库中。 +- 提供必要的链接,如申请流程,术语解释和参考文档等。 +- 同步修改中英文文档,或者在 PR 里面说明。 + +## 提交代码 + +### 提交 Pull Request + +如果你有仓库的开发者权限,而且希望贡献代码,那么你可以创建分支修改代码提交 PR,ykfe 开发团队会 review 代码合并到主干。 + +```bash +# 先创建开发分支开发,分支名应该有含义,避免使用 update、tmp 之类的 +$ git checkout -b branch-name + +# 开发完成后跑下测试是否通过,必要时需要新增或修改测试用例 +$ npm test + +# 测试通过后,提交代码,message 见下面的规范 + +$ git add . # git add -u 删除文件 +$ git commit -m "fix(role): role.use must xxx" +$ git push origin branch-name +``` + +由于谁也无法保证过了多久之后还记得多少,为了后期回溯历史的方便,请在提交 MR 时确保提供了以下信息。 + +1. 需求点(一般关联 issue 或者注释都算) +2. 升级原因(不同于 issue,可以简要描述下为什么要处理) +3. 框架测试点(可以关联到测试文件,不用详细描述,关键点即可) +4. 关注点(针对用户而言,可以没有,一般是不兼容更新等,需要额外提示) + +### 代码风格 + +你的代码风格必须通过 eslint,你可以运行 `$ npm run lint` 本地测试。 + +### Commit 提交规范 + +根据 [angular 规范](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format)提交 commit, +这样 history 看起来更加清晰,还可以自动生成 changelog。 + +```xml +(): + + + +