mirror of
https://github.com/alibaba/lowcode-engine.git
synced 2026-03-07 02:47:12 +00:00
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
---
|
||
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。
|