|
1 | 1 | ---
|
2 |
| -title: 贡献者指南 |
| 2 | +title: 参与贡献 |
3 | 3 | sidebar_position: 0
|
4 | 4 | ---
|
5 |
| -### 首个 Pull Request |
6 |
| -在写第一个 Pull Request?你可以从这一系列视频中学习怎么做: |
7 |
| -[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) |
8 | 5 |
|
9 |
| -为了使你能够快速上手和熟悉贡献流程,我们这里有个列表 [good first issues](https://github.com/alibaba/lowcode-engine/issues?q=is:open+is:issue+label:%22good+first+issue%22),里面有相对没那么笼统的漏洞,从这开始是个不错的选择。 |
| 6 | +### 环境准备 |
| 7 | + |
| 8 | +开发 LowcodeEngine 需要 Node.js 16+。 |
| 9 | + |
| 10 | +推荐使用 nvm 管理 Node.js,避免权限问题的同时,还能够随时切换当前使用的 Node.js 的版本。 |
| 11 | + |
| 12 | +### 贡献低代码引擎 |
| 13 | + |
| 14 | +#### clone 项目 |
| 15 | + |
| 16 | +``` |
| 17 | +git clone [email protected]:alibaba/lowcode-engine.git |
| 18 | +cd lowcode-engine |
| 19 | +``` |
| 20 | + |
| 21 | +#### 安装依赖并构建 |
| 22 | + |
| 23 | +``` |
| 24 | +npm install && npm run setup |
| 25 | +``` |
| 26 | + |
| 27 | +#### 调试环境配置 |
| 28 | + |
| 29 | +本质上是将 demo 页面引入的几个 js/css 代理到 engine 项目,可以使用趁手的代理工具,这里推荐 [XSwitch](https://chrome.google.com/webstore/detail/xswitch/idkjhjggpffolpidfkikidcokdkdaogg?hl=en-US)。 |
| 30 | + |
| 31 | +本地开发代理规则如下: |
| 32 | +```json |
| 33 | +{ |
| 34 | + "proxy": [ |
| 35 | + [ |
| 36 | + "https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/engine-core.js", |
| 37 | + "http://localhost:5555/js/AliLowCodeEngine.js" |
| 38 | + ], |
| 39 | + [ |
| 40 | + "https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/engine-core.css", |
| 41 | + "http://localhost:5555/css/AliLowCodeEngine.css" |
| 42 | + ], |
| 43 | + [ |
| 44 | + "https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/react-simulator-renderer.js", |
| 45 | + "http://localhost:5555/js/ReactSimulatorRenderer.js" |
| 46 | + ], |
| 47 | + [ |
| 48 | + "https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/react-simulator-renderer.css", |
| 49 | + "http://localhost:5555/css/ReactSimulatorRenderer.css" |
| 50 | + ], |
| 51 | + [ |
| 52 | + "https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/js/rax-simulator-renderer.js", |
| 53 | + "http://localhost:5555/js/RaxSimulatorRenderer.js" |
| 54 | + ], |
| 55 | + [ |
| 56 | + "https?://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/(.*)/dist/css/rax-simulator-renderer.css", |
| 57 | + "http://localhost:5555/css/RaxSimulatorRenderer.css" |
| 58 | + ], |
| 59 | + ] |
| 60 | +} |
| 61 | +``` |
| 62 | + |
| 63 | +#### 开发 |
| 64 | + |
| 65 | +``` |
| 66 | +npm start |
| 67 | +``` |
| 68 | + |
| 69 | +选择一个环境进行调试,例如[低代码引擎在线 DEMO](https://lowcode-engine.cn/demo/demo-general/index.html) |
| 70 | + |
| 71 | +开启代理之后,就可以进行开发调试了。 |
10 | 72 |
|
11 |
| -如果你想解决一个 issue,请确定检查了该 issue 下的评论以防有人正在处理它。如果目前没人在处理该 issue,那么请留下评论去表明你想处理该 issue 以便其他人不会意外重复你的工作。 |
12 | 73 |
|
13 |
| -如果有人留言表明要处理该 issue 但是超过两周没有跟进,你可以接手工作,不过也应该留言说明。 |
| 74 | +### 贡献低代码引擎文档 |
14 | 75 |
|
15 |
| -### 提交 Pull Request |
16 |
| -核心团队时刻关注 pull requests,我们会先评审你的 pull request,之后可能会合并,可能会要求再次更改,也可能会关闭该 pull request 并对此作出解释。我们会尽力全程更新和反馈。 |
| 76 | +#### 开发文档 |
17 | 77 |
|
18 |
| -**提交 pull request 前**,请确保完成以下步骤: |
| 78 | +在 lowcode-engine 目录下执行下面命令 |
| 79 | +``` |
| 80 | +cd docs |
19 | 81 |
|
20 |
| -1. Fork [此仓库](https://github.com/alibaba/lowcode-engine),从 main 创建分支。 |
21 |
| -2. 在仓库根目录下执行 yarn。 |
22 |
| -3. 如果你修复了 bug 或者添加了代码,而这些内容需要测试,请添加测试! |
23 |
| -4. 确保通过测试套件(yarn test)。 |
24 |
| -5. 请签订贡献者许可证协议(Contributor License Agreement)。 |
25 |
| - > 如已签署 CLA 仍被提示需要签署,[解决办法](/site/docs/faq/faq021) |
| 82 | +npm start |
| 83 | +``` |
26 | 84 |
|
27 |
| -### 核心贡献者交流 |
28 |
| -如果你想长期参与到项目维护中,我们提供了一个核心贡献者交流群。 |
| 85 | +#### 维护方式 |
| 86 | +- 官方文档通过 github 管理文档源,官网文档与[主仓库 develop 分支](https://github.com/alibaba/lowcode-engine/tree/develop/docs)保持同步。 |
| 87 | +- 点击每篇文档下发的 `编辑此页` 可直接定位到 github 中位置。 |
| 88 | +- 欢迎 PR,文档 PR 也会作为贡献者贡献,会用于贡献度统计。 |
| 89 | +- **文档同步到官方网站由官方人员进行操作**,如有需要可以通过 issue 或 贡献者群与相关人员沟通。 |
| 90 | +- 为了提供更好的阅读和使用体验,文档中的图片文件会定期转换成可信的 CDN 地址。 |
| 91 | + |
| 92 | +#### 文档格式 |
| 93 | + |
| 94 | +本项目文档参考[文档编写指南](https://github.com/sparanoid/chinese-copywriting-guidelines)。 |
| 95 | + |
| 96 | +使用 vscode 进行编辑的朋友可以安装 vscode 插件 [huacnlee.autocorrect](https://github.com/huacnlee/autocorrect) 辅助文档 lint。 |
| 97 | + |
| 98 | + |
| 99 | +### 贡献低代码引擎生态 |
| 100 | + |
| 101 | +相关源码详见[NPM 包对应源码位置汇总](/site/docs/guide/appendix/npms) |
| 102 | + |
| 103 | +开发调试方式详见[低代码生态脚手架 & 调试机制](/site/docs/guide/expand/editor/cli) |
| 104 | + |
| 105 | +### 发布 |
| 106 | + |
| 107 | +PR 被合并之后,我们会尽快发布相关的正式版本或者 beta 版本。 |
| 108 | + |
| 109 | +### 加入 Contributor 群 |
| 110 | +提交过 Bugfix 或 Feature 类 PR 的同学,如果有兴趣一起参与维护 LowcodeEngine,我们提供了一个核心贡献者交流群。 |
29 | 111 |
|
30 | 112 | 1. 可以通过[填写问卷](https://survey.taobao.com/apps/zhiliao/4YEtu9gHF)的方式,参与到其中。
|
31 |
| -2. 填写问卷后加微信号 `wxidvlalalalal` 说明一下。 |
| 113 | +2. 填写问卷后加微信号 `wxidvlalalalal` (注明 github id)我们会拉你到群里。 |
| 114 | + |
| 115 | +如果你不知道可以贡献什么,可以到源码里搜 TODO 或 FIXME 找找。 |
| 116 | + |
| 117 | +为了使你能够快速上手和熟悉贡献流程,我们这里有个列表 [good first issues](https://github.com/alibaba/lowcode-engine/issues?q=is:open+is:issue+label:%22good+first+issue%22),里面有相对没那么笼统的漏洞,从这开始是个不错的选择。 |
| 118 | + |
| 119 | +### PR 提交注意事项 |
| 120 | + |
| 121 | +- lowcode-engine 仓库建议从 develop 创建分支,PR 指向 develop 分支。 |
| 122 | +- 其他仓库从 main 分支创建分支,PR 指向 main 分支 |
| 123 | +- 如果你修复了 bug 或者添加了代码,而这些内容需要测试,请添加测试! |
| 124 | +- 确保通过测试套件(yarn test)。 |
| 125 | +- 请签订贡献者许可证协议(Contributor License Agreement)。 |
| 126 | + > 如已签署 CLA 仍被提示需要签署,[解决办法](/site/docs/faq/faq021) |
0 commit comments