mirror of
https://github.com/alibaba/lowcode-engine.git
synced 2025-12-11 18:42:56 +00:00
docs: update participate docs
This commit is contained in:
liujuping
林熠
parent
70845a1eca
commit
0a50cf5a0d
@ -1,88 +0,0 @@
|
||||
---
|
||||
title: 工程化配置
|
||||
sidebar_position: 3
|
||||
---
|
||||
目前引擎体系共包含 2 个 js 文件 (配套 2 个 css)，即：
|
||||
|
||||
|
||||
```html
|
||||
<!-- 低代码引擎的页面框架样式 -->
|
||||
<link rel="stylesheet" href="https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/css/engine-core.css" />
|
||||
<!-- 低代码引擎官方扩展的样式 -->
|
||||
<link rel="stylesheet" href="https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine-ext/1.0.5/dist/css/engine-ext.css" />
|
||||
|
||||
<!-- 低代码引擎的主包 -->
|
||||
<script crossorigin="anonymous" src="https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/js/engine-core.js"></script>
|
||||
<!-- 低代码引擎官方扩展的主包 -->
|
||||
<script crossorigin="anonymous" src="https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine-ext/1.0.5/dist/js/engine-ext.js"></script>
|
||||
```
|
||||
|
||||
> 注，这里的版本号是示例，请尽量选用最新版
|
||||
|
||||
工程化配置我们进行了统一，具体如下：
|
||||
```shell
|
||||
{
|
||||
"entry": {
|
||||
...
|
||||
},
|
||||
"library": "...",
|
||||
"libraryTarget": "umd",
|
||||
"externals": {
|
||||
"react": "var window.React",
|
||||
"react-dom": "var window.ReactDOM",
|
||||
"prop-types": "var window.PropTypes",
|
||||
"@alilc/lowcode-engine": "var window.AliLowCodeEngine",
|
||||
"@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt",
|
||||
"moment": "var moment",
|
||||
"lodash": "var _",
|
||||
"@alifd/next": "var Next"
|
||||
},
|
||||
"polyfill": false,
|
||||
"outputDir": "dist",
|
||||
"vendor": false,
|
||||
"ignoreHtmlTemplate": true,
|
||||
"sourceMap": true,
|
||||
"plugins": [
|
||||
"build-plugin-react-app",
|
||||
["build-plugin-fusion", {
|
||||
}],
|
||||
["build-plugin-moment-locales", {
|
||||
"locales": ["zh-CN"]
|
||||
}],
|
||||
"./build.plugin.js"
|
||||
]
|
||||
}
|
||||
|
||||
```
|
||||
总结一下，有 2 点：
|
||||
|
||||
1. **都不包含 polyfill，**需要应用级别单独引入 polyfill，推荐动态 polyfill
|
||||
2. **都不包含 lodash / moment / next**
|
||||
|
||||
|
||||
#### 前置依赖资源：
|
||||
```html
|
||||
<link rel="stylesheet" href="//alifd.alicdn.com/npm/@alifd/next/1.20.25/next.min.css">
|
||||
|
||||
<script src="//polyfill.alicdn.com/s/polyfill.min.js?features=default,es2017,es6,fetch,RegeneratorRuntime"></script>
|
||||
<script src="//alifd.alicdn.com/npm/@alifd/next/1.20.25/next.min.js"></script>
|
||||
<script src="//g.alicdn.com/platform/c/lodash/4.6.1/lodash.min.js"></script>
|
||||
<script src="//g.alicdn.com/mylib/moment/2.24.0/min/moment.min.js"></script>
|
||||
```
|
||||
|
||||
|
||||
#### 所有资源：
|
||||
```html
|
||||
<link rel="stylesheet" href="//alifd.alicdn.com/npm/@alifd/next/1.20.25/next.min.css">
|
||||
<link rel="stylesheet" href="//uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/css/engine-core.css"/>
|
||||
<link rel="stylesheet" href="//uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.5/dist/css/engine-ext.css"/>
|
||||
|
||||
<script src="//polyfill.alicdn.com/s/polyfill.min.js?features=default,es2017,es6,fetch,RegeneratorRuntime"></script>
|
||||
<script src="//alifd.alicdn.com/npm/@alifd/next/1.20.25/next.min.js"></script>
|
||||
<script src="//g.alicdn.com/platform/c/lodash/4.6.1/lodash.min.js"></script>
|
||||
<script src="//g.alicdn.com/mylib/moment/2.24.0/min/moment.min.js"></script>
|
||||
<!-- engine-core 引擎的 core，负责引擎的基础模块 -->
|
||||
<script crossorigin="anonymous" src="//uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/js/engine-core.js"></script>
|
||||
<!-- engine-ext 引擎的扩展包，负责收拢内置 setters / plugins，方便迭代 -->
|
||||
<script crossorigin="anonymous" src="//uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.5/dist/js/engine-ext.js"></script>
|
||||
```
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: 参与文档贡献
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## 基本原则
|
||||
|
||||
### 维护方式
|
||||
|
||||
- 官方文档通过 github 管理文档源，官网文档与[主仓库 develop 分支](https://github.com/alibaba/lowcode-engine/tree/develop/docs)保持同步。
|
||||
- 点击每篇文档下发的 `编辑此页` 可直接定位到 github 中位置。
|
||||
- 欢迎 PR，文档 PR 也会作为贡献者贡献，会用于贡献度统计。
|
||||
- **文档同步到官方网站由官方人员进行操作**，如有需要可以通过 issue 或 贡献者群与相关人员沟通。
|
||||
- 为了提供更好的阅读和使用体验，文档中的图片文件会定期转换成可信的 CDN 地址。
|
||||
|
||||
### PR 提交注意事项
|
||||
|
||||
- 指向 develop 分支。
|
||||
- 涉及到图片的，需附在文档同级的 img 目录下，通过相对地址引用。
|
||||
|
||||
### 文档格式
|
||||
|
||||
本项目文档参考[文档编写指南](https://github.com/sparanoid/chinese-copywriting-guidelines)。
|
||||
|
||||
使用 vscode 进行编辑的朋友可以安装 vscode 插件 [huacnlee.autocorrect](https://github.com/huacnlee/autocorrect) 辅助文档 lint。
|
||||
@ -1,31 +1,126 @@
|
||||
---
|
||||
title: 贡献者指南
|
||||
title: 参与贡献
|
||||
sidebar_position: 0
|
||||
---
|
||||
### 首个 Pull Request
|
||||
在写第一个 Pull Request？你可以从这一系列视频中学习怎么做：
|
||||
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
|
||||
|
||||
### 环境准备
|
||||
|
||||
开发 LowcodeEngine 需要 Node.js 16+。
|
||||
|
||||
推荐使用 nvm 管理 Node.js，避免权限问题的同时，还能够随时切换当前使用的 Node.js 的版本。
|
||||
|
||||
### 贡献低代码引擎
|
||||
|
||||
#### clone 项目
|
||||
|
||||
```
|
||||
git clone git@github.com:alibaba/lowcode-engine.git
|
||||
cd lowcode-engine
|
||||
```
|
||||
|
||||
#### 安装依赖并构建
|
||||
|
||||
```
|
||||
npm install && npm run setup
|
||||
```
|
||||
|
||||
#### 调试环境配置
|
||||
|
||||
本质上是将 demo 页面引入的几个 js/css 代理到 engine 项目，可以使用趁手的代理工具，这里推荐 [XSwitch](https://chrome.google.com/webstore/detail/xswitch/idkjhjggpffolpidfkikidcokdkdaogg?hl=en-US)。
|
||||
|
||||
本地开发代理规则如下：
|
||||
```json
|
||||
{
|
||||
"proxy": [
|
||||
[
|
||||
"https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/engine-core.js",
|
||||
"http://localhost:5555/js/AliLowCodeEngine.js"
|
||||
],
|
||||
[
|
||||
"https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/engine-core.css",
|
||||
"http://localhost:5555/css/AliLowCodeEngine.css"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/react-simulator-renderer.js",
|
||||
"http://localhost:5555/js/ReactSimulatorRenderer.js"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/react-simulator-renderer.css",
|
||||
"http://localhost:5555/css/ReactSimulatorRenderer.css"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/rax-simulator-renderer.js",
|
||||
"http://localhost:5555/js/RaxSimulatorRenderer.js"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/rax-simulator-renderer.css",
|
||||
"http://localhost:5555/css/RaxSimulatorRenderer.css"
|
||||
],
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### 开发
|
||||
|
||||
```
|
||||
npm start
|
||||
```
|
||||
|
||||
选择一个环境进行调试，例如[低代码引擎在线 DEMO](https://lowcode-engine.cn/demo/demo-general/index.html)
|
||||
|
||||
开启代理之后，就可以进行开发调试了。
|
||||
|
||||
|
||||
### 贡献低代码引擎文档
|
||||
|
||||
#### 开发文档
|
||||
|
||||
在 lowcode-engine 目录下执行下面命令
|
||||
```
|
||||
cd docs
|
||||
|
||||
npm start
|
||||
```
|
||||
|
||||
#### 维护方式
|
||||
- 官方文档通过 github 管理文档源，官网文档与[主仓库 develop 分支](https://github.com/alibaba/lowcode-engine/tree/develop/docs)保持同步。
|
||||
- 点击每篇文档下发的 `编辑此页` 可直接定位到 github 中位置。
|
||||
- 欢迎 PR，文档 PR 也会作为贡献者贡献，会用于贡献度统计。
|
||||
- **文档同步到官方网站由官方人员进行操作**，如有需要可以通过 issue 或 贡献者群与相关人员沟通。
|
||||
- 为了提供更好的阅读和使用体验，文档中的图片文件会定期转换成可信的 CDN 地址。
|
||||
|
||||
#### 文档格式
|
||||
|
||||
本项目文档参考[文档编写指南](https://github.com/sparanoid/chinese-copywriting-guidelines)。
|
||||
|
||||
使用 vscode 进行编辑的朋友可以安装 vscode 插件 [huacnlee.autocorrect](https://github.com/huacnlee/autocorrect) 辅助文档 lint。
|
||||
|
||||
|
||||
### 贡献低代码引擎生态
|
||||
|
||||
相关源码详见[NPM 包对应源码位置汇总](/site/docs/guide/appendix/npms)
|
||||
|
||||
开发调试方式详见[低代码生态脚手架 & 调试机制](/site/docs/guide/expand/editor/cli)
|
||||
|
||||
### 发布
|
||||
|
||||
PR 被合并之后，我们会尽快发布相关的正式版本或者 beta 版本。
|
||||
|
||||
### 加入 Contributor 群
|
||||
提交过 Bugfix 或 Feature 类 PR 的同学，如果有兴趣一起参与维护 LowcodeEngine，我们提供了一个核心贡献者交流群。
|
||||
|
||||
1. 可以通过[填写问卷](https://survey.taobao.com/apps/zhiliao/4YEtu9gHF)的方式，参与到其中。
|
||||
2. 填写问卷后加微信号 `wxidvlalalalal` （注明 github id）我们会拉你到群里。
|
||||
|
||||
如果你不知道可以贡献什么，可以到源码里搜 TODO 或 FIXME 找找。
|
||||
|
||||
为了使你能够快速上手和熟悉贡献流程，我们这里有个列表 [good first issues](https://github.com/alibaba/lowcode-engine/issues?q=is:open+is:issue+label:%22good+first+issue%22)，里面有相对没那么笼统的漏洞，从这开始是个不错的选择。
|
||||
|
||||
如果你想解决一个 issue，请确定检查了该 issue 下的评论以防有人正在处理它。如果目前没人在处理该 issue，那么请留下评论去表明你想处理该 issue 以便其他人不会意外重复你的工作。
|
||||
### PR 提交注意事项
|
||||
|
||||
如果有人留言表明要处理该 issue 但是超过两周没有跟进，你可以接手工作，不过也应该留言说明。
|
||||
|
||||
### 提交 Pull Request
|
||||
核心团队时刻关注 pull requests，我们会先评审你的 pull request，之后可能会合并，可能会要求再次更改，也可能会关闭该 pull request 并对此作出解释。我们会尽力全程更新和反馈。
|
||||
|
||||
**提交 pull request 前**，请确保完成以下步骤：
|
||||
|
||||
1. Fork [此仓库](https://github.com/alibaba/lowcode-engine)，从 main 创建分支。
|
||||
2. 在仓库根目录下执行 yarn。
|
||||
3. 如果你修复了 bug 或者添加了代码，而这些内容需要测试，请添加测试！
|
||||
4. 确保通过测试套件（yarn test）。
|
||||
5. 请签订贡献者许可证协议（Contributor License Agreement）。
|
||||
> 如已签署 CLA 仍被提示需要签署，[解决办法](/site/docs/faq/faq021)
|
||||
|
||||
### 核心贡献者交流
|
||||
如果你想长期参与到项目维护中，我们提供了一个核心贡献者交流群。
|
||||
|
||||
1. 可以通过[填写问卷](https://survey.taobao.com/apps/zhiliao/4YEtu9gHF)的方式，参与到其中。
|
||||
2. 填写问卷后加微信号 `wxidvlalalalal` 说明一下。
|
||||
- lowcode-engine 仓库建议从 develop 创建分支，PR 指向 develop 分支。
|
||||
- 其他仓库从 main 分支创建分支，PR 指向 main 分支
|
||||
- 如果你修复了 bug 或者添加了代码，而这些内容需要测试，请添加测试！
|
||||
- 确保通过测试套件（yarn test）。
|
||||
- 请签订贡献者许可证协议（Contributor License Agreement）。
|
||||
> 如已签署 CLA 仍被提示需要签署，[解决办法](/site/docs/faq/faq021)
|
||||
@ -1,64 +0,0 @@
|
||||
---
|
||||
title: 调试环境配置
|
||||
sidebar_position: 1
|
||||
---
|
||||
低代码引擎的核心仓库是不包含任何物料、插件、setter 的，它本身用于生成低代码引擎的主包。
|
||||
|
||||
如果您需要对低代码的主包进行开发和调试，需要用到本文里介绍的知识。
|
||||
|
||||
如果您需要对低代码编辑器进行定制，您可能只需要 clone [lowcode-demo 项目](https://github.com/alibaba/lowcode-demo)并进行修改，参考“[配置低代码扩展点](/site/docs/guide/expand/editor/summary)”章节。
|
||||
|
||||
> 前置条件：
|
||||
> node 推荐使用 16.18.0（14.x 也可以）
|
||||
|
||||
### 1. 拉取代码，启动项目
|
||||
```bash
|
||||
git clone git@github.com:alibaba/lowcode-engine.git
|
||||
cd lowcode-engine
|
||||
npm install && npm run setup
|
||||
npm start
|
||||
|
||||
|
||||
git clone git@github.com:alibaba/lowcode-demo.git
|
||||
cd lowcode-demo
|
||||
npm install && npm start
|
||||
```
|
||||
|
||||
### 2. 配置资源代理
|
||||
本质上是将 demo 页面引入的几个 js/css 代理到 engine 项目，可以使用趁手的代理工具，这里推荐 [XSwitch](https://chrome.google.com/webstore/detail/xswitch/idkjhjggpffolpidfkikidcokdkdaogg?hl=en-US)。
|
||||
|
||||
本地开发代理规则如下：
|
||||
```json
|
||||
{
|
||||
"proxy": [
|
||||
[
|
||||
"https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/engine-core.js",
|
||||
"http://localhost:5555/js/AliLowCodeEngine.js"
|
||||
],
|
||||
[
|
||||
"https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/engine-core.css",
|
||||
"http://localhost:5555/css/AliLowCodeEngine.css"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/react-simulator-renderer.js",
|
||||
"http://localhost:5555/js/ReactSimulatorRenderer.js"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/react-simulator-renderer.css",
|
||||
"http://localhost:5555/css/ReactSimulatorRenderer.css"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/rax-simulator-renderer.js",
|
||||
"http://localhost:5555/js/RaxSimulatorRenderer.js"
|
||||
],
|
||||
[
|
||||
"https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/rax-simulator-renderer.css",
|
||||
"http://localhost:5555/css/RaxSimulatorRenderer.css"
|
||||
],
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 本地调试物料/插件/设置器
|
||||
|
||||
详见[低代码生态脚手架 & 调试机制](/site/docs/guide/expand/editor/cli)
|
||||
Loading…
x
Reference in New Issue
Block a user