-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: optimize contribution scripts & docs
- Loading branch information
Showing
7 changed files
with
38 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Cea Contribution Guide | ||
|
||
## 1. Bootstrap repo | ||
|
||
Cea 采用 monorepo 模式,我们首先需要安装和链接依赖,这些操作只需通过一个命令完成: | ||
|
||
```bash | ||
npm run bootstrap | ||
``` | ||
|
||
## 2. Debug packages | ||
|
||
本仓库内置 vscode 调试配置文件,推荐使用 vscode 进行调试 | ||
|
||
## 3. Build packages | ||
|
||
编译所有 NPM 包: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
## 4. Build docs | ||
|
||
重新生成文档: | ||
|
||
```bash | ||
npm run docs | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters