github/lowcode-engine
1
0
Fork 0
mirror of https://github.com/alibaba/lowcode-engine.git synced 2025-12-13 04:03:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add doc for how-to-edit-doc, and some minor doc fix

Browse Source
This commit is contained in:
JackLian 2022-11-29 17:30:29 +08:00 committed by 刘菊萍(絮黎)
parent 5f14347903
commit f49c6299d8
6 changed files with 139 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/participate/config.md
View File

@ -1,5 +1,5 @@
---
title: 引擎的工程化配置
title: 工程化配置
sidebar_position: 3
---
目前引擎体系共包含 3 个 js 文件，即：

17
docs/docs/participate/doc.md Normal file
View File

@ -0,0 +1,17 @@
---
title: 官网文档协作流程
sidebar_position: 3
---
## 基本原则
### 维护方式
- 官方文档通过 github 管理文档源, 官网文档与[主仓库 develop 分支](https://github.com/alibaba/lowcode-engine/tree/develop/docs)保持同步。
- 点击每篇文档下发的 `编辑此页` 可直接定位到 github 中位置。
- 欢迎 PR， 文档 PR 也会作为贡献者贡献，会用于贡献度统计。
- 文档同步到官方网站由官方人员进行操作，如有需要可以通过 issue 或 贡献者群与相关人员沟通。
### PR 方式
- 操作与代码贡献一致，指向 develop 分支。

157
docs/docs/participate/flow.md
View File

@ -1,5 +1,5 @@
---
title: 关于引擎的研发协作流程
title: 研发协作流程
sidebar_position: 2
---
## 代码风格
@ -7,7 +7,8 @@ sidebar_position: 2
## 测试机制
每次提交代码前，务必本地跑一次单元测试，通过后再提交 MR。
假如涉及新的功能，需要**补充相应的单元测试，**目前引擎核心模块的单测覆盖率都在 80%+，假如降低了覆盖率，将会不予以通过。
假如涉及新的功能，需要**补充相应的单元测试**，目前引擎核心模块的单测覆盖率都在 80%+，假如降低了覆盖率，将会不予以通过。
跑单测流程：
@ -19,78 +20,134 @@ sidebar_position: 2
1. commit message 格式遵循 [ConvensionalCommits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
![image.png](https://cdn.nlark.com/yuque/0/2022/png/110793/1645066644352-4de1c64c-bff6-4482-90d1-1fb610aa91f2.png#averageHue=%23eceef0&clientId=u6dcee4f0-35df-4&crop=0&crop=0&crop=1&crop=1&height=297&id=CfpQy&margin=%5Bobject%20Object%5D&name=image.png&originHeight=594&originWidth=2070&originalType=binary&ratio=1&rotation=0&showTitle=false&size=341605&status=done&style=none&taskId=u4499b752-5e24-42f6-9186-280fd5a51aa&title=&width=1035)
2. 请按照一个 bugfix / feature 对应一个 commit，假如不是，请 rebase 后再提交 MR，不要一堆无用的、试验性的 commit
2. 请按照一个 bugfix / feature 对应一个 commit，假如不是，请 rebase 后再提交 MR，不要一堆无用的、试验性的 commit。
好处：从引擎的整体 commit 历史来看，会很清晰，**每个 commit 完成一件确定的事，changelog 也能自动生成。**另外，假如因为某个 commit 导致了 bug，也很容易通过 rebase drop 等方式快速修复。
## 引擎发布机制
日常迭代先从 develop 拉分支，然后自测、单测通过后，提交 MR 到 develop 分支，由发布负责人基于 develop 拉 release/1.0.z 分支~
好处：从引擎的整体 commit 历史来看，会很清晰，**每个 commit 完成一件确定的事，changelog 也能自动生成**。另外，假如因为某个 commit 导致了 bug，也很容易通过 rebase drop 等方式快速修复。
### 分支用途
## 分支用途
- main 分支，最稳定的分支，跟 npm latest 包的内容保持一致
- develop 分支，开发分支，拥有最新的、已经验证过的 feature / bugfix，Pull Request 的**目标合入分支**
- release 分支
- 正式发布分支，命名规则为 release/x.y.z，一般从 develop 拉出来进行发布，x.y.z 为待发布的版本号
- beta 发布分支，命名规则为 release/x.y.z-beta(\.\d+)?，可以快速验证修改，发布 npm beta 版本。
验证通过后，因为 beta 发布分支上会存在无用的 commit（比如 lerna 修改 package.json 这种），所以不直接 PR 到 develop，而是从 develop 拉分支，从 beta 发布分支 cherry pick 有用的 commit 到新分支，然后 PR 到 develop。
### 发布步骤
> **发布需要权限，如果提 PR 之后着急发布可以**[**加入贡献者交流群**](https://www.yuque.com/lce/doc/pctr1f#d5WKy)**。**
## 引擎发布机制
如果是发布正式版本，步骤如下（以发布 1.0.0 版本为例）：
日常迭代先从 develop 拉分支，然后自测、单测通过后，提交 PR 到 develop 分支，由发布负责人基于 develop 拉 release/1.0.z 分支~
### 版本规划
> 此处是理想节奏，实际情况可能会有调整
- 日常迭代 2 周，一般月中或月底
- 特殊情况紧急迭代随时发
- 大Feature迭代，每年 2 - 4 次
### 发布步骤
> **发布需要权限，如果提 PR 之后着急发布可以**[**加入贡献者交流群**](../participate/#核心贡献者交流)**。**
#### 发正式版
步骤如下（以发布 1.0.0 版本为例）：
1. git checkout develop
2. git checkout -b release/1.0.0
3. npm run build
4. npm run pub
5. tnpm run sync（此步骤将发布在 npm 源的包同步到阿里内网源，因为 alifd cdn 将依赖内网 npm 源）
```bash
git checkout develop
```
2. 创建release分支
```bash
git checkout -b release/1.0.0
```
3. build
```bash
npm run build
```
4. 发布到npm
```bash
npm run pub
```
5. 同步到 tnpm 源 & alifd CDN（此步骤将发布在 npm 源的包同步到阿里内网源，因为 alifd cdn 将依赖内网 npm 源）
```bash
tnpm run sync
```
6. 更新[发布日志](https://github.com/alibaba/lowcode-engine/releases)
7. 合并 release/x.x.x 到 main 分支
8. 合并 main 分支到 develop 分支
如果是发布beta 版本，步骤如下（以发布 1.0.1 版本为例）：
1. git checkout develop
2. git checkout -b release/1.0.1-beta
3. npm run build
4. npm run pub:prepatch（将 lerna 版本号从 1.0.0 改到 1.0.1-beta.0，若是从 1.0.1-beta.0 改到 1.0.1-beta.1，则用 npm run pub:prerelease）
5. tnpm run sync
#### 发某版本首个 beta ，如 1.0.1-beta.0
1. 拉 develop 分支
```bash
git checkout develop
```
更新到最新（如需）
```bash
git pull
```
2. 拉 release 分支，此处以 1.0.1 版本做示例
```bash
git checkout -b release/1.0.1-beta
```
3. build
```bash
npm run build
```
4. 发布，此处需有 @alilc scope 发包权限
```bash
npm run pub:prepatch
```
5. 同步到 tnpm 源 & alifd CDN
```bash
tnpm run sync
```
注：在 release/1.0.1-beta 上可以直接提交，以便快速测试和验证，不过如何合入 develop，参考 [分支用途](#uem7W) 一节说明。
#### 发某版本非首个 beta ，如 1.0.1-beta.0 -> 1.0.1-beta.1
1. 切换到 release 分支
```bash
git checkout release/1.0.1-beta
```
2. 更新到 develop 分支最新代码
```bash
git rebase origin/develop
```
3. build
```bash
npm run build
```
4. 发布，此处需有 @alilc scope 发包权限 ***此处命令与发首个 beta 时有变化***
```bash
npm run pub:prerelease
```
5. 同步到 tnpm 源 & alifd CDN
```bash
tnpm run sync
```
### 发布周期
**发布周期暂时不固定，按需发布~**
## 物料发布机制
## DEMO 发布机制
**修改版本号**
手动修改 package.json 的版本号
**build**
```typescript
npm run build
```
**publish**
```typescript
npm run pub
```
需要权限
*发布 beta 版本
```typescript
npm publish --tag beta
```
**同步**
```typescript
tnpm run sync
```
缺少这一步相关的 cdn 地址可能 404
1. **修改版本号**
手动修改 package.json 的版本号
2. **build**
```bash
npm run build
```
3. publish （此步骤需要 npm 发包权限）
```bash
npm run pub
```
如发 beta 版
```bash
npm publish --tag beta
```
4. 同步到 tnpm 源 & alifd CDN
```bash
tnpm run sync
```
**官网生效**
需要在通过阿里内部系统更新 demo 版本

10
docs/docs/participate/index.md
View File

@ -1,12 +1,15 @@
---
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)
为了使你能够快速上手和熟悉贡献流程，我们这里有个列表 [good first issues](https://github.com/alibaba/lowcode-engine/issues?q=is:open+is:issue+label:%22good+first+issue%22)，里面有相对没那么笼统的漏洞，从这开始是个不错的选择。
如果你想解决一个 issue，请确定检查了该 issue 下的评论以防有人正在处理它。如果目前没人在处理该 issue，那么请留下评论去表明你想处理该 issue 以便其他人不会意外重复你的工作。
如果有人留言表明要处理该 issue 但是超过两周没有跟进，你可以接手工作，不过也应该留言说明。
### 提交 Pull Request
@ -22,5 +25,6 @@ sidebar_position: 0
### 核心贡献者交流
如果你想长期参与到项目维护中，我们提供了一个核心贡献者交流群。
1.可以通过[填写问卷](https://survey.taobao.com/apps/zhiliao/4YEtu9gHF)的方式，参与到其中。
2.填写问卷后加微信号 wxidvlalalalal，说明一下
1. 可以通过[填写问卷](https://survey.taobao.com/apps/zhiliao/4YEtu9gHF)的方式，参与到其中。
2. 填写问卷后加微信号 `wxidvlalalalal` 说明一下

9
docs/docs/participate/prepare.md
View File

@ -1,10 +1,12 @@
---
title: 如何配置引擎调试环境
title: 调试环境配置
sidebar_position: 1
---
低代码引擎的核心仓库是不包含任何物料、插件、setter 的，它本身用于生成低代码引擎的主包。
如果您需要对低代码的主包进行开发和调试，需要用到本文里介绍的知识。
如果您需要对低代码编辑器进行定制，您可能只需要 clone [lowcode-demo 项目](https://github.com/alibaba/lowcode-demo)并进行修改，参考“[配置低代码扩展点](https://www.yuque.com/lce/doc/srdo3s#oPhoE)”章节。
如果您需要对低代码编辑器进行定制，您可能只需要 clone [lowcode-demo 项目](https://github.com/alibaba/lowcode-demo)并进行修改，参考“[配置低代码扩展点](/site/docs/guide/expand/editor/summary)”章节。
> 前置条件：
> node >= 14
@ -58,4 +60,5 @@ npm install && npm start
```
### 3. 本地调试物料/插件/设置器
[详见](https://www.yuque.com/lce/doc/ulvlkz#Ioc87)
详见[低代码生态脚手架 & 调试机制](/site/docs/guide/expand/editor/cli)

2
docs/package.json
View File

@ -1,6 +1,6 @@
{
"name": "@alilc/lowcode-engine-docs",
"version": "1.0.0",
"version": "1.0.1",
"description": "低代码引擎版本化文档",
"license": "MIT",
"files": [