feat(docs): update contributing.md
This commit is contained in:
parent
ff4d432c9f
commit
be72548ffc
@ -11,7 +11,7 @@ toc: menu
|
||||
- 修改源码
|
||||
- 提交 pull request
|
||||
|
||||
## Local start-up
|
||||
## Installation and start-up
|
||||
|
||||
```bash
|
||||
# 将以下 git 地址换成自己的 repo
|
||||
@ -25,7 +25,34 @@ yarn nocobase init --import-demo
|
||||
yarn start
|
||||
```
|
||||
|
||||
## Build
|
||||
浏览器内打开 http://localhost:8000/
|
||||
|
||||
<Alert title="注意">
|
||||
参与核心代码开发,项目启动打开的是文档页,并非应用的登录页。
|
||||
</Alert>
|
||||
|
||||
## Main scripts
|
||||
|
||||
### Startup and reboot
|
||||
|
||||
以上命令只在第一次执行,之后重启项目只需要
|
||||
|
||||
```bash
|
||||
yarn start
|
||||
```
|
||||
|
||||
### Reinstallation
|
||||
|
||||
如果想清空重新安装
|
||||
|
||||
```bash
|
||||
# 如果需要导入 demo 数据,可以加上 --import-demo
|
||||
yarn nocobase init --import-demo
|
||||
# 重装之后,也需要重启
|
||||
yarn start
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
<Alert title="注意">
|
||||
|
||||
@ -53,7 +80,7 @@ yarn build <package_name_1> <package_name_2>
|
||||
# yarn build database
|
||||
```
|
||||
|
||||
## Test
|
||||
### Testing
|
||||
|
||||
<Alert title="注意">
|
||||
|
||||
@ -69,6 +96,10 @@ yarn test
|
||||
yarn test packages/<name>
|
||||
```
|
||||
|
||||
### More scripts
|
||||
|
||||
查看 package.json 的 [scripts](https://github.com/nocobase/nocobase/blob/ff4d432c9fc3faa38cd65ab6d4dad250da02c2fd/package.json#L7)
|
||||
|
||||
## Document revision and translation
|
||||
|
||||
文档在 [docs](https://github.com/nocobase/nocobase/tree/develop/docs) 目录下,遵循 Markdown 语法,默认为英文,中文以 `.zh-CN.md` 结尾,如:
|
||||
|
@ -11,7 +11,7 @@ toc: menu
|
||||
- 修改源码
|
||||
- 提交 pull request
|
||||
|
||||
## 本地启动
|
||||
## 安装与启动
|
||||
|
||||
```bash
|
||||
# 将以下 git 地址换成自己的 repo
|
||||
@ -25,7 +25,34 @@ yarn nocobase init --import-demo
|
||||
yarn start
|
||||
```
|
||||
|
||||
## 打包编译
|
||||
浏览器内打开 http://localhost:8000/
|
||||
|
||||
<Alert title="注意">
|
||||
参与核心代码开发,项目启动打开的是文档页,并非应用的登录页。
|
||||
</Alert>
|
||||
|
||||
## 主要的 Scripts
|
||||
|
||||
### 启动与重启
|
||||
|
||||
以上命令只在第一次执行,之后重启项目只需要
|
||||
|
||||
```bash
|
||||
yarn start
|
||||
```
|
||||
|
||||
### 重新安装
|
||||
|
||||
如果想清空重新安装
|
||||
|
||||
```bash
|
||||
# 如果需要导入 demo 数据,可以加上 --import-demo
|
||||
yarn nocobase init --import-demo
|
||||
# 重装之后,也需要重启
|
||||
yarn start
|
||||
```
|
||||
|
||||
### 打包编译
|
||||
|
||||
<Alert title="注意">
|
||||
|
||||
@ -53,7 +80,7 @@ yarn build <package_name_1> <package_name_2>
|
||||
# yarn build database
|
||||
```
|
||||
|
||||
## 测试
|
||||
### 测试
|
||||
|
||||
<Alert title="注意">
|
||||
|
||||
@ -69,6 +96,10 @@ yarn test
|
||||
yarn test packages/<name>
|
||||
```
|
||||
|
||||
### 更多命令
|
||||
|
||||
查看 package.json 的 [scripts](https://github.com/nocobase/nocobase/blob/ff4d432c9fc3faa38cd65ab6d4dad250da02c2fd/package.json#L7)
|
||||
|
||||
## 文档修改和翻译
|
||||
|
||||
文档在 [docs](https://github.com/nocobase/nocobase/tree/develop/docs) 目录下,遵循 Markdown 语法,默认为英文,中文以 `.zh-CN.md` 结尾,如:
|
||||
|
Loading…
Reference in New Issue
Block a user