2021-05-27 13:35:08 +08:00
|
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
|
|
- For document & bug fix, please create pull request to `main` branch.
|
|
|
|
|
|
- For new features, please create pull request to `feat` branch.
|
|
|
|
|
|
|
2021-06-05 23:18:03 +08:00
|
|
|
|
## Useful Commands
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
# open the dev server, please note that hot module reload doesn't work well
|
|
|
|
|
|
# if you find anything doesn't work, just refresh the page
|
2021-06-08 12:16:08 +08:00
|
|
|
|
# if you can't open the page at first time, try to do some refresh
|
2021-06-05 23:18:03 +08:00
|
|
|
|
npm run dev
|
|
|
|
|
|
|
|
|
|
|
|
# testing
|
|
|
|
|
|
npm run test
|
|
|
|
|
|
|
|
|
|
|
|
# testing some component
|
|
|
|
|
|
npm run test -- src/xxx
|
|
|
|
|
|
|
|
|
|
|
|
# testing with coverage
|
|
|
|
|
|
npm run test:cov
|
|
|
|
|
|
|
|
|
|
|
|
# lint code
|
|
|
|
|
|
npm run lint:code
|
|
|
|
|
|
|
|
|
|
|
|
# check type
|
|
|
|
|
|
npm run lint:type
|
|
|
|
|
|
|
|
|
|
|
|
# lint code & type
|
|
|
|
|
|
npm run lint
|
2021-06-13 14:38:35 +08:00
|
|
|
|
|
|
|
|
|
|
# build site (if vercel preview failed, you may need to run `git clean -fdx` before)
|
|
|
|
|
|
npm run build:site
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## About Docs and Changelog Format
|
|
|
|
|
|
|
|
|
|
|
|
- Add period `.` to each description in English API tables (and each log of changelogs).
|
|
|
|
|
|
- Don't add period `。` in any description in Chinese API tables (and any log of changelogs).
|
|
|
|
|
|
- Add space bewteen Chinese and Latin charactors.
|
|
|
|
|
|
- Don't use Chinese punctuation in English docs.
|
|
|
|
|
|
|
|
|
|
|
|
For Example:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
English API table:
|
|
|
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
|
| example | `any` | `undefined` | Need period. |
|
|
|
|
|
|
|
|
|
|
|
|
Chinese API table:
|
|
|
|
|
|
| 名称 | 类型 | 默认值 | 说明 |
|
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
|
| example | `any` | `undefined` | 描述不要加句号 |
|
|
|
|
|
|
|
|
|
|
|
|
English Changelog:
|
|
|
|
|
|
- Some changes, need period.
|
|
|
|
|
|
|
|
|
|
|
|
Chinese Changelog:
|
|
|
|
|
|
- 一些变更，不要加句号
|
|
|
|
|
|
|
|
|
|
|
|
Space bewteen Chinese and Latin charactors:
|
|
|
|
|
|
星之 star 卡比 kirby
|
2021-06-05 23:18:03 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
2021-05-27 13:35:08 +08:00
|
|
|
|
# 贡献代码
|
|
|
|
|
|
|
|
|
|
|
|
- 对于文档和 bug fix，请对 `main` 分支提交 Pull Request
|
|
|
|
|
|
- 对于新特性，请对 `feat` 分支提交 Pull Request
|
2021-06-05 23:18:03 +08:00
|
|
|
|
|
|
|
|
|
|
## 有用的指令
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
# 开启开发服务器，注意热更新不是很好用
|
|
|
|
|
|
# 如果你觉得哪里有问题，刷新页面即可
|
2021-06-08 12:16:08 +08:00
|
|
|
|
# 第一次运行打不开时，你可以试试刷新几次浏览器
|
2021-06-05 23:18:03 +08:00
|
|
|
|
npm run dev
|
|
|
|
|
|
|
|
|
|
|
|
# 测试
|
|
|
|
|
|
npm run test
|
|
|
|
|
|
|
|
|
|
|
|
# 测试某个组件
|
|
|
|
|
|
npm run test -- src/xxx
|
|
|
|
|
|
|
|
|
|
|
|
# 生成覆盖率报告
|
|
|
|
|
|
npm run test:cov
|
|
|
|
|
|
|
|
|
|
|
|
# 检查代码风格
|
|
|
|
|
|
npm run lint:code
|
|
|
|
|
|
|
|
|
|
|
|
# 检查类型
|
|
|
|
|
|
npm run lint:type
|
|
|
|
|
|
|
|
|
|
|
|
# 上面俩个都检查
|
|
|
|
|
|
npm run lint
|
2021-06-13 14:38:35 +08:00
|
|
|
|
|
|
|
|
|
|
# 构建文档网站（如果 vercel 的预览挂掉了，你可能需要先运行一下 `git clean -fdx`）
|
|
|
|
|
|
npm run build:site
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 关于文档和变更日志的格式
|
|
|
|
|
|
|
|
|
|
|
|
- 每一条英文的变更日志和英文的 API 表中的 description 都需要加英文句号 `.`
|
|
|
|
|
|
- 不要在中文 API 表和中文的变更日志中加句号
|
|
|
|
|
|
- 在每一个中文和拉丁字母（数字）之间要加空格
|
|
|
|
|
|
- 不要在英文文档中使用中文标点
|
|
|
|
|
|
|
|
|
|
|
|
例如:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
英文 API 表格：
|
|
|
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
|
| example | `any` | `undefined` | Need period. |
|
|
|
|
|
|
|
|
|
|
|
|
中文 API 表格：
|
|
|
|
|
|
| 名称 | 类型 | 默认值 | 说明 |
|
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
|
| example | `any` | `undefined` | 描述不要加句号 |
|
|
|
|
|
|
|
|
|
|
|
|
English Changelog:
|
|
|
|
|
|
- Some changes, need period.
|
|
|
|
|
|
|
|
|
|
|
|
Chinese Changelog:
|
|
|
|
|
|
- 一些变更，不要加句号
|
|
|
|
|
|
|
|
|
|
|
|
中英文之间要加空格：
|
|
|
|
|
|
星之 star 卡比 kirby
|
2021-06-05 23:18:03 +08:00
|
|
|
|
```
|
